## 🐰 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 paywalls. - **REST & GraphQL API.** Instantly layers a blazingly fast Node.js API on top of any SQL database. - **Manage pure SQL.** Works with new or existing SQL databases, no migration required. - **Choose your database.** Supports PostgreSQL, MySQL, SQLite, OracleDB, CockroachDB, MariaDB, and MS-SQL. - **On-Prem or Cloud.** Run locally, install on-premises, or use our [self-service Cloud service](https://directus.io/pricing) (free tier available). - **Completely extensible.** Built to white-label, it is easy to customize our modular platform. - **A modern dashboard.** Our no-code Vue.js app is safe and intuitive for non-technical users, no training required. **[Learn more about Directus](https://directus.io)**
## 🚀 Directus Cloud [Directus Cloud](https://directus.io/pricing) allows you to create free Community Cloud projects in 90 seconds. - **Free Community Cloud tier available (no credit card required)** - **No product limitations or service usage quotas (unlimited users, API requests, etc)** - A modern self-service dashboard to create and monitor all your projects in one place - End-to-end solution: Directus, database, serverless auto-scaling, storage, and a global CDN - Hourly usage-based pricing for our Standard Cloud allows you to pay-as-you-go - Select your desired region and provision a new project in ~90 seconds **[Create your Free Project](https://directus.cloud)**
## ⚙️ 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.
## 📌 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](https://dev.mysql.com/doc/refman/8.0/en/upgrading-from-previous-series.html#upgrade-caching-sha2-password-compatible-connectors)) - MariaDB 10.2.7+ - SQLite 3+ - CockroachDB 21.1.13+^[1] - MS SQL 13+^[1] - OracleDB 19+^{[1] [1]} Older versions may work, but aren't officially tested/supported. #### Supported OS - Ubuntu 18.04 - CentOS / RHEL 8 - macOS Catalina or newer - Windows 10/11 - Docker ([DockerHub](https://hub.docker.com/r/directus/directus) + [Dockerfile](https://github.com/directus/directus/blob/main/docker/Dockerfile)) _Other operating systems may also work, but are not officially supported._
## 🤔 Community Help [The Directus Documentation](https://docs.directus.io) is a great place to start, or explore these other channels: - [Discord](https://directus.chat) (Live Discussions) - [GitHub Issues](https://github.com/directus/directus/issues) (Report Bugs) - [GitHub Discussions](https://github.com/directus/directus/discussions) (Questions, Feature Requests) - [Twitter](https://twitter.com/directus) (Latest News) - [YouTube](https://www.youtube.com/c/DirectusVideos/featured) (Video Tutorials)
## ❤️ Contributing & Sponsoring Please read our [Contributing Guide](./contributing.md) before submitting Pull Requests. All security vulnerabilities should be reported in accordance with our [Security Policy](https://docs.directus.io/contributing/introduction/#reporting-security-vulnerabilities). Directus is a premium open-source ([GPLv3](./license)) project, made possible with support from our passionate core team, talented contributors, and amazing [GitHub Sponsors](https://github.com/sponsors/directus). Thank you all!
© 2004-2022, Monospace Inc