# Directus

> Turn any SQL database into an instant REST and GraphQL API with a no-code admin app

- Category: App UIs & Builders / Low-Code & No-Code Builders
- Language: TypeScript
- Licence: Monospace Sustainable Core License (MSCL) 1.0
- Repository: https://github.com/directus/directus
- Website: https://directus.io
- Canonical page: https://ai-tldr.dev/tools/directus/

## In short

Directus is an open-source data platform that connects to a SQL database and instantly exposes its contents through a REST and GraphQL API, alongside a no-code admin dashboard for managing that content. It sits in the Low-Code & No-Code Builders category of the App UIs & Builders tools and is open-source, written in TypeScript and licensed Monospace Sustainable Core License (MSCL) 1.0.

## Overview

Directus is an open-source data platform that connects to a SQL database and instantly exposes its contents through a REST and GraphQL API, alongside a no-code admin dashboard for managing that content. It works with both new and existing databases without requiring a migration, so it maps directly onto whatever schema you already have.

It is built for teams that need a back-office and content layer on top of their data: developers who want an API without writing CRUD boilerplate, and non-technical users who manage records through the Vue.js admin app. Supported databases include PostgreSQL, MySQL, SQLite, MariaDB, MS-SQL, OracleDB, and CockroachDB.

As a low-code / no-code builder, Directus sits between a raw database and a hand-built application. You can run it locally, self-host on-premises, or use Directus Cloud, and extend its modular platform when you need behavior beyond the defaults.

## What it does

- Layers a REST and GraphQL API on top of any supported SQL database
- Works with new or existing databases with no migration required
- Supports PostgreSQL, MySQL, SQLite, MariaDB, MS-SQL, OracleDB, and CockroachDB
- No-code Vue.js admin dashboard aimed at non-technical users
- Run locally, self-host on-premises, or use the hosted Directus Cloud
- Modular and white-labelable, so the platform can be customized and extended

## Getting started

The fastest way to try Directus is the official Docker image, which starts the API and admin app together. The README does not document an npm install command, so the Docker quickstart below is the grounded starting point.

1. Run Directus with Docker

   Start a Directus instance on port 8055 using the official image.

```bash
docker run -p 8055:8055 directus/directus
```

2. Open the admin app

   Visit the running instance in your browser, then follow the onboarding screen to configure your first admin account.

```text
http://localhost:8055
```

3. Connect your own database

   For a persistent setup, the docs recommend Docker Compose so you can configure a SECRET and point Directus at your own SQL database, then bring the stack up.

```bash
docker compose up
```

## When to use it

- Give an existing SQL database an instant REST and GraphQL API without writing CRUD code
- Provide non-technical team members a no-code dashboard to manage content and records
- Use Directus as a headless CMS or content backend for websites and apps
- Build internal back-office tools on top of company data