* extension takes context object * v-model with options object * removed comments * added typing * fixed typing * state is saved on field-configuration * extension-options uses object for objectOptions * removed unnecessary context * more props instead of context object * remove unused import * move Panel type to shared * passing edits.options => whole edit object * alterOptions check => edits watch * props on extension types have defaults * returning the whole panel not just .options * panels without functions load * only displaying first, last, and count * first last count working * string values displayed! * removed unused vars * choices disabled not removed * options.function resets to count * fills in values when editing a panel * field resets when collection changes * doesn't wipe collection on edit * panel cleared when panel type changes * removed resolved comment * package.json * Advanced Field Detail working * divider on type of function * divider option removed unneeded values * removed unneeded v-if * Don't check against function type in panel options * Tweaks to resolve my own commentary * 🧹 Cleanup tweaks Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
🐰 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 SQL. Works with existing SQL databases, or helps build new architectures from scratch.
- Choose your database. Supports PostgreSQL, MySQL, SQLite, OracleDB, MariaDB and MS-SQL.
- Allows self-hosting. Choose your 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. A Vue.js Admin App so safe and intuitive, non-technical users require no training.
Learn more about Directus on our website.
⚙️ Installation
Create a new Directus project by running the following npm command:
npm init 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.
🚀 One-Click Deployments
If you would like to completely avoid the manual installation process, the following self-hosted one-click apps will handle the heavy-lifting for you. While Directus is always completely free, you will likely need to pay for these services.
| Google Cloud | Cleavr | Cloudron | DigitalOcean | Heroku | Platform.sh | Zeet |
|---|---|---|---|---|---|---|
![]() |
📌 Requirements
Directus only requires Node.js and supports most operating systems and SQL database vendors.
- Node.js 12.20+
- npm 6.x+
Supported Databases
- PostgreSQL 10+
- MySQL 5.7.8+ / 8+ (with mysql_native_password)
- MariaDB 10.2.7+
- SQLite 3+
- MS SQL 13+[1]
- OracleDB 19+[1]
[1] Older versions may work, but aren't officially supported.
Supported OS
- Ubuntu 18.04
- CentOS / RHEL 8
- macOS Catalina or newer
- Windows 10
- Docker (DockerHub + Dockerfile)
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 & Sponsoring
Please read our Contributing Guide before submitting Pull Requests.
All security vulnerabilities should be reported in accordance with our Security Policy.
Directus is a premium open-source (GPLv3) project, made possible with support from our passionate core team, talented contributors, and amazing GitHub Sponsors. Thank you all!
© 2004-2022, Monospace Inc

