thedanielhanke / directus Goto Github PK

Open-Source Headless CMS & API

Directus is free and open-source and we like to keep it that way.
Please help us out by supporting the project on Patreon!

Directus is a free and open-source database API and 'headless' CMS. Unlike traditional CMS that encompass your entire project codebase, the decoupled approach of Directus offers an API and SDKs to connect your content to: websites, native apps, kiosks, IoT devices, or any other data-driven projects.

Directus makes no assumptions about how you should architect your database – giving you complete freedom to optimize structure and performance for projects of any size or complexity. Built on top of the API is our feature-rich admin webapp (CMS) which dynamically maps to your database's schema, instantly providing your users/clients with an intuitive interface for managing content.

Learn more at getdirectus.com, chat with us on Slack, and follow us on Twitter: @directus

Download the latest pre-built version from our releases page or clone this repo and install the composer dependencies by running composer install from the root folder.

NGINX or Apache Server, MySQL 5.2+, PHP 5.5+ (curl, gd, finfo, pdo_mysql)

While Directus has been abstracted to allow for different database adapters in the future, currently only MySQL is supported. PostgreSQL, SQLite, and MongoDB support is under development – and we hope to expand support for additional database types as we gain contributors.

The full documentation about using the admin Directus can be found over at docs.getdirectus.com.

You can find the source of this documentation in our docs repo.

Our full API reference can be found over at api.getdirectus.com. Together with the endpoints and supported params, you can also find code examples for our supported SDKs.

You can find the source of this documentation in our API docs repo.

First of all, thank you for taking the time to work on Directus!

The following is a set of guidelines for contributing to Directus and its components. These are just guidelines, not strict rules. Feel free to propose changes to this and other documents in a pull request.

Think you've discovered a bug? First, read through our docs to be sure – then submit a ticket to our GitHub Issues. And if you already know a good solution, we love Pull Requests! For all security related issues, please chat with us directly through getdirectus.com.

Directus has multilingual support – and we're looking for anyone interested in helping translate our English default language file into other languages. It's as easy as copying that en.json file and changing the values!

PR any translations into this Directory.

Huge thanks to the following contributors!

• 🇺🇸 @benhaynes
• 🇫🇷 @EmilienCo & @JackNUMBER
• 🇪🇸 @WellingGuzman
• 🇩🇪 @katywings & @ymilhahn
• 🇨🇳 @TigerHix & @Gfast2
• 🇧🇷 @michaelnagy
• 🇮🇹 @AeonZh
• 🇳🇱 @rijkvanzanten
• 🇯🇵 @hokkaidobeard
• 🇳🇴 @franctic-aerobic

Use our Feature Request Tool to request new features or vote on existing commmunity suggestions.

Unsure where to begin contributing to Directus? You can start by looking through the Beginner, good first issue and Help Wanted issues. Beginner and good first issue issues are issues that often only require a few lines of code. Help wanted issues are a bit more involved than beginner issues.

Want to help but have some trouble understanding the issue, ask us and we will help you to get you started.

Pull requests are always welcome for every part of Directus. Please make sure to adhere to our .editorconfig rules and to lint your code with XO.

This is what we want to get done next:

• CMS App Decoupled from API
• API 2.0 - Speed improvements, better relational filtering / querying and increased i18n support

• Begin work on Directus v7.0 (moving from Backbone to Vue)

• Support for multiple database (multitenant)

• Digital Asset Management improvements

• Web Hooks

• GraphQL endpoint

• Support for PostgreSQL DBs

• Marketplace for easier distribution of interfaces / extensions

• Project Lead: Ben Haynes
• Development Lead: Welling Guzmán
• Interface Lead: Rijk van Zanten

Key developers: coolov, freen, jel-massih, Lasha

Sponsors: Bas Jansen

• Directus Core codebase released under the GPLv3 license.
• Example Code, Design Previews, Demonstration Apps, Custom Extensions, Custom interfaces, and Documentation copyright 2017 RANGER Studio LLC.
• RANGER Studio owns all Directus trademarks, service marks, and graphic logos on behalf of our project's community. The names of all Directus projects are trademarks of RANGER Studio LLC.