Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updates directus with current details #707

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 45 additions & 33 deletions src/site/headless-cms/directus.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,57 +7,69 @@ opensource: "Yes"
typeofcms: "API Driven"
supportedgenerators:
- All
description: Directus is a database-first platform that provides an instant REST API for custom SQL databases and an intuitive Admin App for non-technical users to manage that content.
description: Directus is an Open Data Platform that layers on top of any new or existing SQL database, instantly providing a dynamic REST+GraphQL API and an intuitive no-code CMS for managing content.
images:
- path: https://docs.directus.io/assets/img/item-detail.dacd91c4.png
- path: https://directus.io/assets/img/screenshots/v9/item-listing.png
---
Directus is an open-source suite of software that provides an instant API wrapper for SQL databases and an intuitive Admin App for non-technical users to manage that content. It's like a safe, friendly, and super-powered "database client" (eg: _PHP-my-Admin_ or _Sequel Pro_). Created in 2004, our premium platform powers hundreds-of-thousands of data-driven applications around the world. With our JSON API, webhooks, and complete control over where and how your content is used — what will you build with Directus?
Directus is an Open Data Platform that layers on top of any new or existing SQL database, instantly providing a dynamic REST+GraphQL API and an intuitive no-code CMS for managing content. It is like a safe, friendly, and super-powered _Database Management Tool_. Our venture-backed company

<img class="simple" src="https://docs.directus.io/assets/img/item-detail.dacd91c4.png" alt="Directus 7 — Item Edit" />
## Key Features

## Architecture
* 100% JavaScript / TypeScript Codebase Built in Node.js and Vue.js 3
* Completely Open-Source (GPLv3) with No Paywalls or Artificial Limitations
* Supports Any SQL Database (New or Existing), No Migration Needed
* PostgreSQL, MySQL, SQLite, CockroachDB, Microsoft SQL Server, OracleDB, MariaDB, Aurora, RedShift, and more!
* GraphQL or REST API Auto-Generated Based on your Database Schema, JavaScript SDK, CLI, and SQL Queries
* Completely Modular and Extensible Across the App and API
* Filter-Based Permissions for Granular Access Control and Role-Based Validation
* Authentication Support for System Credentials, SSO, OAuth2, OpenID/OIDC, LDAP, SAML, 2FA
* Full Digital Asset Management with Nestable Folders and On-The-Fly Image Transformations
* Webhooks, Event Hooks, Redis Caching, Custom Rate Limiter, Revision History, and more!

The **[Directus API](https://github.com/directus/api)** wraps any new or existing SQL database with RESTful JSON endpoints for connecting content anywhere: websites, native apps, wearables, IoT devices, kiosks, or anything else! ([API Reference](https://docs.directus.io/api/reference.html))
## Community Metrics

The **[Directus Admin App](https://github.com/directus/app)** is a friendly admin interface built with Vue.js that works in conjunction with our API to allow non-technical users to manage database content and digital assets. ([User Guide](https://docs.directus.io/guides/user-guide.html))
* 13,000,000+ Docker Installs
* 13,000+ GitHub Stars
* 40,000+ Twitter Followers
* 4,000+ Discord Members
* 300+ Contributors
* 10+ Core Team Members

The **[Directus Suite](https://github.com/directus/directus)** is a package that combines our API, Admin App, and all dependencies for quick and easy installation on most servers. ([Docs](https://docs.directus.io))
<img class="simple" src="https://directus.io/assets/img/screenshots/v9/item-listing.png" alt="Directus 9 — Item Listing" />
<img class="simple" src="https://directus.io/assets/img/screenshots/v9/item-detail.png" alt="Directus 9 — Item Detail" />
<img class="simple" src="https://directus.io/assets/img/screenshots/v9/file-library.png" alt="Directus 9 — File Library" />
<img class="simple" src="https://directus.io/assets/img/screenshots/v9/permissions.png" alt="Directus 9 — Permissions" />
<img class="simple" src="https://directus.io/assets/img/screenshots/v9/docs.png" alt="Directus 9 — Docs" />

## Database-First
## Core Principles

Directus follows a database-first approach, storing all of your data _unaltered_ in pure SQL databases with that can be completely cusotmized. Benefits to this approach include:
Directus is a simple solution for complex problems, with a data-first approach guided by the following core principles:

### Portability and Transparency
* **Pure** — No predefined or proprietary schema, with all system metadata stored separately
* **Open** — Public and transparent codebase with no obfuscated or cloud-only code
* **Portable** — Database can be exported or migrated at any time with no vendor lock-in
* **Limitless** — No artificial limitations or paywalls on users, roles, languages, collections, or items
* **Extensible** — Every aspect of the platform is modular to avoid any hard feature ceilings
* **Unopinionated** — Choose your stack, database, and architecture; self-hosted or on cloud

Directus is _not_ a black-box system. There is nothing proprietary or opinionated about how Directus stores your content so you're never locked-in or locked out. Import existing SQL to get started quickly, and rest assured that you can also export your unaltered content as vanilla SQL at any point. You can also self-host the entire suite on your own servers if needed or use our hosted Cloud service.
## Database Mirroring

### Access and Optimization
**Directus is installed as a layer on top of your new or existing SQL database, with its App and API dynamically “mirroring” your actual schema and content in real-time.** This approach is similar to how technical database clients (like _phpMyAdmin_) work, however Directus provides an experience that is safe, intuitive, and powerful enough for anyone... even the most non-technical users.

Directus mirrors _your_ actual database so it will automatically stay in sync with any changes made directly to the database! With the full power of SQL unlocked, you can:
Database mirroring has many unique advantages:

1. Architect your actual database with meaningful table and column names
2. Infinitely optimize with indexing, datatypes, lengths, defaults, keys, encoding, etc
3. Update your database schema at any point and Directus will instantly reflect changes
4. Create, update, and delete content directly from the database
* Control over your pure SQL database schema, tailored to your exact requirements
* Significant performance improvements through optimizations and indexing
* Complete transparency, portability, and security for your data
* Direct database access and the full power of raw/complex SQL queries
* Allows importing existing databases, unaltered and without any migrations

This database-first approach means that you have the option to completely bypass Directus as needed. Connecting your application directly to the database means Directus is completely bypassed, removing even the slightest possibility of a bottleneck, and giving you the unbridled power of SQL.
Other platforms typically use a predefined or proprietary “one-size-fits-all” data model to store your content (have you ever peeked behind the curtain of a WordPress installation? Yikes!). That is not the case with Directus. Directus gives you direct access to your pure and unaltered data. That means you have the option to bypass the Directus middleware (API, SDK, App) and connect to your data with proper SQL queries. This effectively removes all bottlenecks, latency overhead, and proprietary access limitations.

### Complex Relationships

Whether you need many-to-one, one-to-many, many-to-many, or something completely different... Directus has you covered. You can interrelate database fields, then fetch deeply nested data using our robust dot-notation parameters.

## Simple, Modular and Extensible

We've intentionally kept our codebase as simple and lightweight as possible. Every aspect of Directus has been modularized, with many options for extending, overriding, or even bypassing the core system. Choose your auth providers, storage adapters, content interfaces, data presentation, and more. We also have webhooks, event hooks, API response filters, custom endpoints, CSS/JS override files, and much more.

## Internationalization and Accessibility
## Multilingual Content & Internationalization

Directus allows you to manage multilingual content in as many languages as your project needs. And no matter what language(s) your organization requires, our Admin App supports a growing number of locales. We've also paid close attention to our Admin App's interface to ensure it is as clear and accessible as possible for all users.

## Resources

Directus is released under the GPLv3 license and is managed by [RANGER Studio LLC](http://rangerstudio.com). It's easy to self-host your own instance of Directus, below are a few links to help you get started:

[Directus.io](https://directus.io) • [GitHub](https://github.com/directus/directus) • [Docs](https://docs.directus.io) • [API Reference](https://docs.directus.io/api/reference.html) • [User Guide](https://docs.directus.io/guides/user-guide.html) • [Demo](https://directus.app) • [Contribute](https://docs.directus.io/getting-started/supporting-directus.html) • [Slack](https://slack.directus.io) • [Twitter](https://twitter.com/directus)

<style>.images{display:none}</style>
[Website](https://directus.io) • [GitHub](https://github.com/directus/directus) • [Cloud](https://directus.cloud/) • [Docs](https://docs.directus.io) • [API Reference](https://docs.directus.io/reference/introduction/) • [User Guide](https://docs.directus.io/app/overview/) • [Discord](https://directus.chat) • [Twitter](https://twitter.com/directus) • [YouTube](https://www.youtube.com/c/DirectusVideos)