🐰 Introduction

Directus is a real-time API and App dashboard for managing SQL database content.

• Free & open-source. No artificial limitations, vendor lock-in, or hidden pricing.
• REST & GraphQL API. Instantly adds a blazingly fast Node.js API layer to your database.
• Manage pure, custom SQL. Works with existing SQL databases, or create new architectures from scratch.
• Choose your database. Supports PostgreSQL, MySQL, SQLite, OracleDB, MariaDB and MS-SQL.
• Allows self-hosting. Choose your own hosting and infrastructure, run locally, or deeply integrate on-premises.
• Completely extensible. Built to white-label, it is easy to customize our modular platform.
• A modern dashboard. Our Vue.js Admin App is safe and intuitive enough for non-technical users without training.

Learn more about Directus on our website.

🚧 Alpha

DO NOT USE THIS VERSION IN PRODUCTION.

This is pre-release software, therefore migrations will not be provided, breaking changes may occur at any time, and certain features might be missing or broken. You can follow along with the issue tracker for an in-depth list of upcoming enhancements, with the following notable features still under development:

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

⚙️ Installation

Create a new Directus project by running the following npm command:

npx create-directus-project my-project

Or, using yarn:

yarn create directus-project my-project

Simply follow the setup prompts and the CLI will create your new project directory (eg: my-project), configuration file, and initial database. To get the most out of Directus, and to ensure you have the latest security patches, it is important to keep your projects up-to-date. For more information, view our docs on Updates & Migrations.

✨ Requirements

Directus only requires Node.js (or PHP), and supports most operating systems and SQL database vendors.

• Node.js 10+
• npm 6.x+

Supported Databases

• PostgreSQL 10+
• MySQL 5.6+
• MariaDB 10.1+
• SQLite 3+
• MS-SQL X.X+
• OracleDB X.X+

Supported OS

• Ubuntu 18.04
• CentOS / RHEL 8
• macOS Catalina
• Windows 10
• Docker (DockerHub + Docker Repo)

Other operating systems may also work, but are not officially supported.

🤔 Community Help

In addition to the Directus Documentation, you can also request help via the following channels:

• Discord (Live Discussions)
• GitHub Issues (Report Bugs)
• GitHub Discussions (Questions, Feature Requests)
• Twitter (Latest News)
• YouTube (Video Tutorials)

🔧 Contributing

Please read our Contributing Guide before submitting Pull Requests.

❤️ Supporting Directus

Directus is a premium open-source project, made possible with support from our core team, contributors, and sponsors: GitHub Sponsors

📄 License

Offered free and open-source under the GPLv3 license. Monospace Inc owns all Directus trademarks and logos on behalf of our project's community.

© 2006-2020, Monospace Inc.