Skip to content

Latest commit

 

History

History
112 lines (87 loc) · 5.73 KB

README.md

File metadata and controls

112 lines (87 loc) · 5.73 KB
Raw

Nuxt-Directus Dockerized Deployment

Forked from Intevel/nuxt-directus, this project dockerizes the Nuxt-Directus application for easy deployment.

Features

Feature Description
🐳 Dockerized Deployment Simplifies the setup and deployment process.
🐰 Directus Integration Open-source headless CMS and API.
🛠️ Nuxt Devtools Debugging tools for Nuxt.js.
🖥️ Nuxt UI A UI Kit for building Nuxt modules and projects.
🍬 Tailwind CSS Add Tailwind CSS to your Nuxt Applications.
🌗 Nuxt Color Mode Dark and Light mode with auto detection.
🛸 ufo Utilities to work with URLs across Nuxt projects.
📜 TypeScript Support Ensures type safety in your project.
🚀 Nuxt 3 Compatible with the latest version of Nuxt.
🔗 RESTful methods Convenient way to access or update resources on the server.
🔑 Environment Variables Easily configure your app settings.

  1. Clone the repository:

    git clone https://github.com/srjrol/nuxt-directus-docker
cd nuxt-directus-docker

  2. Setup your environment variables: Copy the .env.example to a new file named .env and update the variables as needed.

    cp .env.example .env

Deployment

  1. Build and run the Docker containers:

    docker-compose up --build -d

  2. Access the application:

    • 🚀 Nuxt App: http://localhost:3000
    • 🐰 Directus Admin: http://localhost:8055

Environment Variables Reference Table

Variable Description
POSTGRES_USER PostgreSQL username
POSTGRES_PASSWORD PostgreSQL password
POSTGRES_DB PostgreSQL database name
DIRECTUS_URL Directus URL
DIRECTUS_KEY Directus Key
DIRECTUS_SECRET Directus Secret
ADMIN_EMAIL Admin email for Directus
ADMIN_PASSWORD Admin password for Directus
PUBLIC_URL Public URL for Directus
CONTENT_SECURITY_POLICY_DIRECTIVES__FRAME_ANCESTORS Content Security Policy Directives for frame ancestors
API_URL API URL for Nuxt
NUXT_PUBLIC_DIRECTUS_URL Public Directus URL for Nuxt
NUXT_PUBLIC_API_BASE Public API base URL for Nuxt

Integrate to your application.

Features

  • Nuxt 3 ready
  • Handle authentication
  • RESTful methods
  • TypeScript Support

Setup

  1. Clone the repository:
git clone https://github.com/srjrol/nuxt-directus-docker.git
cd nuxt-directus-docker

Basic usage

Development

  1. Clone this repository
  2. Install dependencies using pnpm install or npm install
  3. Run pnpm dev:prepare or npm run dev:prepare
  4. Start development server using pnpm dev or npm run dev

Todo

  • Optimize Dockerfile for faster build times.
  • Add a Makefile to simplify build and deploy commands.
  • Implement a logging system for troubleshooting and monitoring.
  • Add authentication and authorization for enhanced security.
  • Upgrade to the latest versions of Nuxt and Directus.
  • Document the setup and deployment process in more detail.
  • Create a backup and restore process for the database.
  • Add CI/CD integration for automated testing and deployment.
  • Improve error handling and add proper error messages.
  • Include a feature for data migration and schema updates.

License

Copyright (c) 2022 Sean Jennings, originally developed by Conner Luka Bachmann MIT License

Additional Resources