mirror of
https://github.com/directus/directus.git
synced 2026-01-27 20:27:56 -05:00
d2a311b20e
* .gitignored package-lock.json that was created in the docs subfolder * added cloud section structure * set initial article outlines * drafter accts-teams and shifted cloud docs in navbar * added overview and projects draft * added tiers and billing outline and basics * added image to drafts and polished text. needs one more pass. added css for dngr on icons * Added photos to overview * minor tweak on images * imrpoved copy and expanded CSS for inline icons * expnaded CSS and, added images and finished copy on acct-n-team * more copy touchups * Add divider between cloud and regular docs * Fix capitalization of Github -> GitHub * fixed overview images and tweaked copy * recructured pages. Added writing tasks on appropriate pages * added accts, options, and teams pages * Overview intro (re)written) * overview initial copy * Overview first draft complete, links not added, media not added * accounts initial draft complete, no media * teams redrafted, projects and options partial refactoring * projects redrafted * finalized 5th page as glossay and reformatted * refactored glossary structure * glossary terms p1 * glossary copy 80% complete * more glossary copy * cloud glossary basic copy probably 100% done * checked hyperlinks * initial proofread on overview * initial accounts proofread * re-edited billing sections * re-editec projects section and glossary * re-edited teams * small edits * edited accounts, teams, projects * re-edited glossary * added screenshot-based media, still need graphic illustrations * small, tiny edits * fixed GitHub capitalization and other small type error * applied ben's edit suggestions on overview, accounts, and 1/2 of projects * applied the rest of Ben's edits * added missing screenshots * proof-read * Fixed Team proejcts title * tweaked copy after my ~10 questions to ben * reworked 'projects > create a project' sections and 'glossary > data-processing' section * final copy touchup, link check, still missing Rijk's review Co-authored-by: rijkvanzanten <rijkvanzanten@me.com> Co-authored-by: Eron Powell <eronpowell@Erons-MBP-2.local> Co-authored-by: Eron Powell <eronpowell@Erons-MBP-2.hitronhub.home>
🐰 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 (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.
🚀 Directus Cloud
Directus Cloud 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
⚙️ 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)
- 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 + Dockerfile)
Other operating systems may also work, but are not officially supported.
🤔 Community Help
The Directus Documentation is a great place to start, or explore these other 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