directus README

The project's README from github.com/directus/directus. As one markdown file: README.md.

directus/readme.md

directus (directus/directus)

no-code
Searching Database…

38.6K ·GitHub
What is this?Directus is an open-source backend platform that wraps your existing SQL database with instant REST and GraphQL APIs, a no-code admin app, authentication, and fine-grained permissions - turning any database into a headless CMS, admin panel, or custom app backend.
Is this a library I import, or a full app I run?It is a full backend application you deploy (via Docker or Node.js) that sits in front of your own SQL database and auto-generates APIs plus a Vue-based admin app - not a code library you import into another project.
How do I get it running?Run 'npx create-directus-project' for a guided setup, or clone the repo and use the included Docker Compose configuration to spin up Directus alongside a database.
What do I need installed before running it?You need Node.js 22 and pnpm 10+ to build it from source (or just Docker), plus a SQL database such as PostgreSQL, MySQL, MariaDB, SQLite, or MSSQL for it to connect to.
Does it run on any OS, or only certain environments?As a Node.js app it runs on Linux, macOS, and Windows, and ships with Docker/Docker Compose support for self-hosting; the admin app itself is used through a web browser.
What is Directus exactly - a CMS or something more?Directus is broader than a typical CMS: it wraps any SQL database with auto-generated REST and GraphQL APIs, an admin app, and granular permissions, so it can power CMS sites, admin panels, or entirely custom apps.
Can I build a custom front-end on top of it?Yes - the generated REST/GraphQL APIs let you build any custom UI (web, mobile, etc.), while the built-in admin app is just for content and data management.
Which databases does it support?Directus connects to PostgreSQL, MySQL, MariaDB, SQLite, MSSQL, and other SQL databases using your existing schema rather than creating a proprietary data store.
Is there a hosted option if I do not want to self-host?Yes, alongside the open-source self-hosted version, Directus offers a managed Cloud offering.
Creator
directus
Size
443.9 MB
Stars
38.6K
Age
13y
Commits · 90 Days