This repository has been archived by the owner on Jan 6, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 204
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
72f8112
commit 601e511
Showing
52 changed files
with
434 additions
and
217 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,7 +16,8 @@ | |
<a href="https://docs.directus.io/api/reference.html">API Reference</a> • | ||
<a href="https://docs.directus.io/guides/user-guide.html">User Guide</a> • | ||
<a href="https://directus.app">Demo</a> • | ||
<a href="https://docs.directus.io/getting-started/supporting-directus.html">Contribute</a> | ||
<a href="https://docs.directus.io/getting-started/supporting-directus.html">Contribute</a> • | ||
<a href="https://twitter.com/directus">Twitter</a> | ||
</h3> | ||
|
||
<p> </p> | ||
|
@@ -32,12 +33,50 @@ | |
|
||
## 🐰 Introduction | ||
|
||
Directus is an open-source suite of software for managing content in projects of any size. Instances of the [Directus API](https://github.com/directus/api) allow you to easily connect SQL database content anywhere (websites, native apps, wearables, IoT devices, kiosks, etc) while the [Directus App](https://github.com/directus/app) allows non-technical users to intuitively manage that content. You can easily install a build of the full [Directus Suite](https://github.com/directus/directus) which includes the App, API, and all dependencies. | ||
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? | ||
|
||
* **No Assumptions.** That’s our motto, and we mean it. It’s your content, your workflow, your stack, your servers, and your database – Directus stays out of the way. | ||
* **Pure, decoupled content.** Directus stores all your data unaltered, in SQL databases designed by you. Connect to your data from anywhere everywhere. | ||
* **Directus is a simple toolkit, not a one-size-fits-all behemoth.** Every aspect of the framework can be tailored, extended, or even bypassed if needed. Truly limitless. | ||
* **Full internationalization.** Manage multilingual content in as many languages as your project needs. And for international teams, the Directus App itself supports translations. | ||
* **[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! | ||
* **[Directus Admin App](https://github.com/directus/app)** — 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. | ||
* **[Directus Suite](https://github.com/directus/directus)** A package that combines our API, Admin App, and all dependencies for quick and easy installation on most servers. | ||
|
||
<p> </p> | ||
|
||
## ✨ Key Concepts | ||
|
||
### Database-First | ||
|
||
Directus follows a database-first approach, storing all of your data _unaltered_ in pure SQL databases with that can be completely cusotmized. | ||
|
||
#### Access and Optimization | ||
|
||
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: | ||
|
||
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 | ||
|
||
#### Direct Access | ||
|
||
This database-first approach means that you have the option to completely bypass Directus if needed. Connecting your application _directly_ to the database means Directus is completely bypassed, removing even the slightest possiblility of a bottleneck, and giving you the unbridled power of complex SQL queries. | ||
|
||
#### Portability and Transparency | ||
|
||
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. | ||
|
||
#### 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. | ||
|
||
Furthermore, because the codebase has been internally decoupled, Directus supports full multitenancy. You can use a single Directus App to manage multiple Directus API instances, and each API instance can manage multiple databases (projects or environments). | ||
|
||
### Internationalization and Accessibility | ||
|
||
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. | ||
|
||
<p> </p> | ||
|
||
|
@@ -62,40 +101,27 @@ Directus is an open-source suite of software for managing content in projects of | |
|
||
## 🤲 Help & Resources | ||
|
||
### Open-Source Support | ||
|
||
For help with open-source instances please post questions with the `directus` tag on [Stack Overflow](https://stackoverflow.com/questions/tagged/directus). | ||
|
||
### Premium Support | ||
### Technical Support | ||
|
||
[Premium Support](https://directus.io) is only available to Directus Cloud customers, Patreon Sponsors, and Contracted Clients. | ||
* **Community Support** — For help with open-source instances please post questions with the `directus` tag on [Stack Overflow](https://stackoverflow.com/questions/tagged/directus) or chat with members of our online community. | ||
* **Premium Support** — Directus Cloud customers, Patreon Sponsors, and those paying for hourly support all have access to our Live support over our [Live Chat](https://directus.io) or [Email](mailto:[email protected]). | ||
|
||
### Reporting Bugs | ||
### Community | ||
|
||
If you believe you've found a bug in the Directus Core codebase, please submit new tickets to either the [App](https://github.com/directus/app/issues/new?template=Bug_report.md) or the [API](https://github.com/directus/api/issues/new?template=Bug_report.md). **For all security related issues, please chat with us directly through [directus.io](https://directus.io/).** | ||
* **[Slack](https://slack.directus.io)** — Come join almost a thousand members discussing the future of Directus. Our helpful members are also quick to offer advice for simple questions you may have while getting started. | ||
* **[Twitter](https://twitter.com/directus)** — Follow us on Twitter to be the first to hear about product updates, see sneak peeks of new features, and vote on polls regarding the future of our platform. | ||
|
||
### Community Discussions | ||
### GitHub Tickets | ||
|
||
Join us on [Slack](https://slack.getdirectus.com) to talk to hundreds of members of the Directus community. | ||
|
||
### Updates & Social | ||
|
||
Follow us on [Twitter](https://twitter.com/directus) to be the first to hear about product updates and sneak peeks. | ||
|
||
### Feature Requests | ||
|
||
Feature requests are managed as GitHub issues within the appropriate Directus repository. Before making a new submission, first [browse existing feature requests](https://github.com/directus/app/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement) using the `enhancement` label. If you find a similar request, simply vote for it using the :+1: or :-1: reactions and add any additional context in the comments. If _not_, [add a new feature request](https://github.com/directus/app/issues/new?template=Feature_request.md) by completing the provided template. | ||
|
||
### Contributing | ||
|
||
We love pull-requests! To work on Directus you'll need to install it locally from source by following the instructions below. Submit all pull-requests to the `development` branch of our `api` and `app` repositories. | ||
|
||
* [Setup API Development Environment](https://docs.directus.io/advanced/source.html#api-source) | ||
* [Setup App Development Environment](https://docs.directus.io/advanced/source.html#application-source) | ||
* **Reporting Bugs** — If you believe you've found a bug in the Directus Core codebase, please submit new tickets to either the [App](https://github.com/directus/app/issues/new?template=Bug_report.md) or the [API](https://github.com/directus/api/issues/new?template=Bug_report.md). **For all security related issues, please chat with us directly through [directus.io](https://directus.io/).** | ||
* **Requesting Features** — Feature requests are managed as GitHub issues within the appropriate Directus repository. Before making a new submission, first [browse existing feature requests](https://github.com/directus/app/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement) using the `enhancement` label. If you find a similar request, simply vote for it using the :+1: or :-1: reactions and add any additional context in the comments. If _not_, [add a new feature request](https://github.com/directus/app/issues/new?template=Feature_request.md) by completing the provided template. | ||
|
||
### Online Demos | ||
|
||
We have two online demos available so you can easily check out Directus in action: [stable](https://directus.app) or [canary](https://next.directus.app). The credentials to login are: `[email protected]` and `password` | ||
We have two online demos available so you can easily check out Directus in action. These demos are public and is therefore susceptible to trolls who think it's funny to write offensive things or change the master user password. The entire database is reset each hour to mitigate this. The login credentials for both demos: `[email protected]` and `password` | ||
|
||
* **[Stable](https://directus.app)** — This demo showcases the [latest release](https://github.com/directus/directus/releases/latest) of the Directus suite. | ||
* **[Canary](https://next.directus.app)** — This demo uses the [latest commits](https://github.com/directus/directus/commits/master) from the `master` branch. | ||
|
||
<p> </p> | ||
|
||
|
@@ -107,6 +133,14 @@ Directus is a GPLv3-licensed open source project with development made possible | |
* [One-time donation through PayPal](https://www.paypal.me/supportdirectus) | ||
* [Other ways to help](https://docs.directus.io/getting-started/supporting-directus.html) | ||
|
||
|
||
### Contributing | ||
|
||
We love pull-requests! To work on Directus you'll need to install it locally from source by following the instructions below. Submit all pull-requests to the `master` branch of our `api` and `app` repositories. | ||
|
||
* [Setup API Development Environment](https://docs.directus.io/advanced/source.html#api-source) | ||
* [Setup App Development Environment](https://docs.directus.io/advanced/source.html#application-source) | ||
|
||
### Sponsors | ||
|
||
[RANGER Studio](http://rangerstudio.com), Bas Jansen | ||
|
@@ -125,11 +159,6 @@ Directus is a GPLv3-licensed open source project with development made possible | |
Rijk van Zanten</a><br> | ||
<i>App Lead</i> | ||
</td> | ||
<td> | ||
<a href="https://github.com/wellingguzman"><img width="160px" src="https://user-images.githubusercontent.com/522079/42234534-dfc56d1c-7ec2-11e8-94ca-7b422788d6cd.jpg"><br> | ||
Welling Guzmán</a><br> | ||
<i>API Lead</i> | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
public/extensions/core/interfaces/checkboxes-relational/display.css
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
6 changes: 6 additions & 0 deletions
6
public/extensions/core/interfaces/checkboxes-relational/display.js
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
1 change: 1 addition & 0 deletions
1
public/extensions/core/interfaces/checkboxes-relational/input.css
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.