This repo provides a collection of starter templates for building web applications with Directus integration. Initially, this includes a Simple CMS, but upcoming templates will also include Simple CRM and Simple eCommerce solutions.
Each template is designed to be:
- Reusable: Modular codebases that can be easily extended.
- Framework-Specific: Tailored implementations for popular frameworks like Next.js, Nuxt.js, Svelte, and Astro.
- Scalable: Suitable for small to medium projects and scalable to larger applications.
Template | Status | Description |
---|---|---|
Simple CMS | 🚧 In Progress | A starter CMS template for managing content. |
Simple CRM | 🕒 Upcoming | A CRM template for managing customer data. |
Simple eCommerce | 🕒 Upcoming | A template for building eCommerce solutions. |
-
Create a New Project:
- Visit Directus Cloud and create a new project.
- During the setup process, be sure to select the appropriate template for your project (Simple CMS, Simple CRM, or Simple eCommerce).
- Once started, it will take around 90 seconds for the Cloud Project to be created.
- You will receive an email with your project URL, email, and password for logging in.
- If you used GitHub to create your account, this will be your GitHub email.
-
Access Your New Project:
- Log in to your project using the URL provided in your email or from the Directus Cloud Dashboard.
-
Select a Template:
- Navigate to the folder for the framework you want to use in this repo.
- Follow the instructions in that template's README to set up your application and connect it to your cloud instance.
For local development, follow these steps:
-
Install Docker:
- Ensure Docker is installed and running on your machine: Download Docker.
-
Clone the Template You Want:
- Select the template folder for your chosen framework (e.g.,
simple-cms
) and clone it:git clone https://github.com/your-org/starters.git simple-cms cd simple-cms
- Select the template folder for your chosen framework (e.g.,
-
Navigate to the
directus/
Folder:- Inside your cloned template folder, navigate to the
directus/
folder:cd directus
- Inside your cloned template folder, navigate to the
-
Start Directus:
-
Run Docker Compose to start the Directus instance:
docker-compose up -d
-
This will start Directus on http://localhost:8055. Use the following credentials to log in:
- Admin Email:
[email protected]
- Admin Password:
d1r3ctu5
- Admin Email:
-
-
Apply a Template:
-
Use the Directus Template CLI to apply a pre-configured template for your project. Follow these steps:
-
**Generate a static token for the admin user:
- Go to the Users Directory
- Choose the Administrative User
- Scroll down to the Token field and generate a static token.
- Copy the token and save it. Do not forget to save the user, or you will encounter an "Invalid token" error.
-
Run the Template CLI Tool:
- Open your terminal, run the following command, and follow the prompts:
npx directus-template-cli@latest apply
- Open your terminal, run the following command, and follow the prompts:
-
Follow the Prompts:
- Choose
Community templates
- Select the template from the list to apply (Simple Website CMS, Simple CRM, or Simple eCommerce)
- Fill in your Directus URL
http://localhost:8055
- Select
Directus Access Token
- Fill in the token you saved from Step 1
- Choose
-
-