directus

NOTE: This is pre-release software and should be treated as such. DO NOT use this in production. Migrations between versions aren't provided, and breaking changes might happen at any release.

🚧 Alpha

Note that this is an alpha version of the software. This means that certain features might be missing or broken. The following (big) features are still being worked on:

GraphQL Endpoint
MS SQL Support
OracleDB Support
App Permissions
Import/Export Endpoints
Caching
Rate Limiting

See the issue tracker for a more in-depth list of all things coming up.

⚙️ Installation

Directus requires NodeJS 10+

We've created a little CLI tool you can use to quickly start up a Directus project. You can use it by running:

npx create-directus-project my-project

or using yarn:

yarn create directus-project my-project

on the command line. This will create the given directory, setup the configuration, and install the database.

✨ Updating

To update an existing Directus project, navigate to your project directory and run:

npm update

🔧 Contributing

Please report any and all quirks / issues you come across as an issue.

Pull requests are more than welcome and always appreciated. Seeing this is in active development, please make sure to reach out a member of the core team in an issue or on Discord before you start working on a feature or bug to ensure you don't work on the same thing as somebody else :)

To install the project locally:

Clone the repo
Run npm run bootstrap in the root
Run npm run dev to start the dev environment for the Directus suite

❤️ Supporting Directus

Directus is a GPLv3-licensed open source project with development made possible by support from our core team, contributors, and sponsors. It's not easy building premium open-source software; if you would like to help ensure Directus stays free, please consider becoming a sponsor.

📄 License

Languages

TypeScript 73.3%

Vue 24.6%

SCSS 0.7%

JavaScript 0.7%

Liquid 0.4%

Other 0.3%