817ccf3620
* Add Quickstart Guide * Update installation * Remove unused files * Update support/backing * Tweaks in concepts * Setup file structure for API reference 2.0 * Setup page layout for reference * Add clean-urls plugin * getting started updates * Finish authentication rest * getting started updates * Render stylus in 2 spaces * Various * Various * Finish activity docs * Add collections reference * Add extension reference * concepts updates * Fields/tweaks * Add files doc * Add revisions * concepts docs * More api reference * Finish rest api reference (finally) * initial concepts * More things * Add assets api ref * Move sections from file to assets * Add environment variables * contributing docs * Add field transforms page * Left align table headers * concept links * Add API config * Fix mobile nav * Add migrating a project * doc link fixes Co-authored-by: Ben Haynes <ben@rngr.org>
1.8 KiB
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.
::: tip Minimum Requirements
You will need to have a minimum of Node 12+ to build a Development version of Directus, though it is recommended that you are on the most "current" version of Node.js.
:::
1. Fork the Directus repository
Go to the repository 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
npm install
5. Setup the Database & Env File
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 -- init
6. Start the development server
Run the following command from the root directory.
npm run dev
::: tip
If you encounter errors during this installation process, make sure your node version meets the minimum requirements
:::
7. 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.