mirror of
https://github.com/directus/directus.git
synced 2026-01-24 19:47:58 -05:00
100 lines
3.5 KiB
Markdown
100 lines
3.5 KiB
Markdown
<p align="center"><img width="400" alt="Logo" src="https://user-images.githubusercontent.com/522079/89687381-23943700-d8ce-11ea-9a4d-ae3eae136423.png"></p>
|
|
|
|
<br>
|
|
|
|
## 🐰 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 pricing.
|
|
* **REST & GraphQL API.** Instantly adds a blazingly fast Node.js API layer to your database.
|
|
* **Manage pure SQL.** Works with existing SQL databases, or helps build new architectures from scratch.
|
|
* **Choose your database.** Supports PostgreSQL, MySQL, SQLite, OracleDB, MariaDB and MS-SQL.
|
|
* **Allows self-hosting.** Choose your hosting and infrastructure, run locally, or deeply integrate on-premises.
|
|
* **Completely extensible.** Built to white-label, it is easy to customize our modular platform.
|
|
* **A modern dashboard.** A Vue.js Admin App so safe and intuitive, non-technical users require no training.
|
|
|
|
**[Learn more about Directus on our website.](https://directus.io)**
|
|
|
|
<br>
|
|
|
|
## 🚧 Beta
|
|
|
|
**DO NOT USE THIS VERSION IN PRODUCTION.**
|
|
|
|
This is *pre-release* software, therefore migrations will not be provided, breaking changes may occur at any time, and certain features might be missing or broken. You can follow along with [the issue tracker](https://github.com/directus/next/issues) for an in-depth list of upcoming enhancements, with the following notable features still under development:
|
|
|
|
- [ ] MS SQL Support
|
|
- [ ] OracleDB Support
|
|
- [ ] Import/Export Endpoints
|
|
|
|
<br>
|
|
|
|
## ⚙️ Installation
|
|
|
|
Create a new Directus project by running the following npm command:
|
|
|
|
```
|
|
npx create-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. For more information, view our docs on [Updates & Migrations](#).
|
|
|
|
<br>
|
|
|
|
## 📌 Requirements
|
|
|
|
Directus only requires Node.js (or [PHP](https://github.com/directus/api-next)), and supports most operating systems and SQL database vendors.
|
|
|
|
* Node.js 10+
|
|
* npm 6.x+
|
|
|
|
#### Supported Databases
|
|
|
|
* PostgreSQL 10+
|
|
* MySQL 5.6+
|
|
* MariaDB 10.1+
|
|
* SQLite 3+
|
|
* MS-SQL X.X+
|
|
* OracleDB X.X+
|
|
|
|
#### Supported OS
|
|
|
|
* Ubuntu 18.04
|
|
* CentOS / RHEL 8
|
|
* macOS Catalina
|
|
* Windows 10
|
|
* Docker ([DockerHub](https://hub.docker.com/r/directus/directus) + [Docker Repo](https://github.com/directus/docker))
|
|
|
|
_Other operating systems may also work, but are not officially supported._
|
|
|
|
<br>
|
|
|
|
## 🤔 Community Help
|
|
|
|
In addition to the [Directus Documentation](https://docs.directus.io), you can also request help via the following channels:
|
|
|
|
* [Discord](http://discord.gg/directus) (Live Discussions)
|
|
* [GitHub Issues](https://github.com/directus/next/issues) (Report Bugs)
|
|
* [GitHub Discussions](https://github.com/directus/next/discussions/category_choices) (Questions, Feature Requests)
|
|
* [Twitter](https://twitter.com/directus) (Latest News)
|
|
* [YouTube](https://www.youtube.com/c/DirectusVideos/featured) (Video Tutorials)
|
|
|
|
<br>
|
|
|
|
## ❤️ Contributing & Sponsoring
|
|
|
|
Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting Pull Requests.
|
|
|
|
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!
|
|
|
|
<br>
|
|
|
|
© 2006-2020, Monospace Inc
|