Running Locally

This guide explains how to install the Development version of Directus locally so that you can work on the platform's source code. To install the Production version locally, please follow to our standard installation guides.

Minimum Requirements

You will need to have the latest version of Node (opens new window) to build a Development version of Directus.

1. Fork the Directus repository

Go to the repository (opens new window) and fork it to your GitHub account. A fork is your copy of the Directus repository. Forking the repository allows you to freely experiment with changes without affecting the original project.

2. Clone from your repository

git clone git@github.com:YOUR-USERNAME/directus.git

3. Make a new branch

git checkout -b YOUR-BRANCH-NAME

4. Install the dependencies and build the project

npm install
npm run build

5. Create a .env file

Create a .env file under the api folder the API to use. You can use the example.env file provided under api as a starting point.

6. Setup the Database

For this step, you'll need to already have a SQL database up-and-running, otherwise you can only use the SQLite driver, which will create the database for you. Run the following command from within root of the project:

npm run cli bootstrap

This will install Directus, and make sure all the migrations have run.

7. Start the development server

Run the following command from the root directory.

npm run dev

If you are only looking to work on the Documentation (public website version), you can navigate to the docs directory and run the following command:

npm run dev:site

TIP

If you encounter errors during this installation process, make sure your node version meets the minimum requirements

8. Make your fixes/changes

At this point you are ready to start working on Directus! Before diving in however, it's worth reading through our docs on submitting a pull-request.