The Directus Docs 🐰 — The official Documentation for the Directus Modern Data Stack

Last update: Aug 10, 2022

Directus Logo


🐰 Introduction

This is the official documentation for the Directus data platform. These docs are also available via a public website.

Learn more about Directus
Create your Free Project


Contributing

Note

This project uses pnpm to manage the dependencies, install it if you haven't via npm i -g pnpm.

  1. Fork and clone the repo
  2. Install the dependencies through pnpm install
  3. Run the docs website by running pnpm dev

🤔 Community Help

The Directus Documentation is a great place to start, or explore these other channels:


Directus is a premium open-source (GPLv3) project, made possible with support from our passionate core team, talented contributors, and amazing GitHub Sponsors. Thank you all!


© 2004-2022, Monospace Inc

GitHub

https://github.com/directus/docs
Comments
  • 1. Hi-Fi images for the Data Model PR

    Hi Fi images for configuration > data-model.md and configuration > data-model > relationships.md Required in order to complete PR https://github.com/directus/docs/pull/23

    Reviewed by erondpowell at 2022-07-20 21:57
  • 2. Docs: Data Model

    Description

    Updates to the Data Models Docs

    TODO

    • [x] Lay out new initial page structure
    • [x] Redistribute content from old Data Model pages into new pages
    • [x] "Hide" the Fields pages (to be released in a second PR)
    • [x] Draft Data Model
    • [x] Draft Collections
    • [x] Draft System Collections
    • [x] Draft Fields
    • [x] Draft Relations
    • [x] Add Sketches https://github.com/directus/docs/issues/51
    • [x] Add Media
    • [x] Final Proofedits
    • [x] Tag manager for editorial review
    Reviewed by erondpowell at 2022-06-29 23:35
  • 3. VitePress

    Solution to #42

    TODO:

    • [x] Install VitePress and setup basic configurations
    • [x] Import all docs content (with limited sidebar, until nested pages get supported)
    • [x] Bring in Public Images
    • [x] Homepage (setup the default theme homepage, with dummy text)
    • [x] Inline Material Icons
    • [x] Add in previous CSS colors
      • [ ] Customize CSS
    • [x] Tidy up Reference snippets
    • [x] Add Thumbsmith
      • [ ] Refactor thumbsmith logic within config.js
    • [x] Add simple-git-hooks, prettier, and linter
    • [ ] Badges (Cloud Exclusive & Extensions & etc. )
    • [ ] Add Hubspot
    • [ ] Add in Algolia
    • [ ] Link to Netlify
    Reviewed by erondpowell at 2022-06-29 22:59
  • 4. Website on the phone.

    Describe the Bug

    While browsing the website with the documentation, being at its bottom, when the link to the next tab is too short, you cannot click it because the chat icon covers it IMG_20220702_145018

    The second thing is a broken link you can see in the screenshot Screenshot_2022-07-02-14-46-21-065_com android chrome

    To Reproduce

    Go to the website by telephone

    Errors Shown

    No response

    What version of Directus are you using?

    Directus website

    What version of Node.js are you using?

    Directus website

    What database are you using?

    Directus website

    What browser are you using?

    Directus website

    How are you deploying Directus?

    Directus website

    Reviewed by koksikus at 2022-07-02 13:09
  • 5. Docs: Extensions > migrations update

    Discussed in https://github.com/directus/directus/discussions/14826

    Originally posted by infomiho August 3, 2022

    Describe the Bug

    When doing some new feature, we used a version for migration 20220308A which collided with one of the internal migrations 20220308A-add-bookmark-icon-and-color.ts

    The culprit is here https://github.com/directus/directus/blob/main/api/src/database/migrations/run.ts#L28 - there is not differentiation between custom and internal migrations, which probably should be addressed. The user shouldn't track the list of internal migrations writing his own.

    Maybe prefix the custom migration versions? (Not sure how to make this backwards compatible) Or maybe emphasise in the docs to name the custom migrations 20220308customA-create-table.js

    To Reproduce

    Create a custom migration file 20220308A-test-migration.js

    Errors Shown

    Error: Migration keys collide! Please ensure that every migration uses a unique key.

    What version of Directus are you using?

    9.13.0

    Reviewed by erondpowell at 2022-08-10 17:13
  • 6. Clarify possible properties for file uploads

    Ref https://github.com/directus/directus/issues/14975#issuecomment-1209449462

    Clarify that filename_disk and filename_download are excluded from the properties that can be overridden when uploading a file.

    Reviewed by azrikahar at 2022-08-10 11:11
  • 7. Update docs contributing steps

    As https://github.com/directus/docs/commit/4fa0150264d704109a6145140e7c80785ba453aa added pnpm lock file, I assume it'd be more suitable to move to pnpm in contributing steps?

    As an aside, not sure should package-lock.json be removed from .gitignore as well since it seems abit odd to ignore it:

    https://github.com/directus/docs/blob/900cf146915e0ed05e17c9e0f1045de6c7544ce9/.gitignore#L3

    Reviewed by azrikahar at 2022-07-29 11:32
  • 8. Added one-click deployment to Elest.io

    I have added a link to deploy Directus on Elestio in one-click Elestio is a new platform offering fully managed services for 175 open-source softwares. We take care of deployment/security/backup/monitoring/software updates and more.

    We do revenue sharing with open-source authors (I sent a partnership email as well to Directus) We would love to be listed as an option to deploy Directus

    Reviewed by jbenguira at 2022-07-29 09:02
  • 9. Use new spelling of DB_POOL config

    See: https://github.com/directus/directus/commit/1c508c8bc5d51b50bdbec4e181645c8ccb4af2c6#commitcomment-78626937

    Perhaps there should also be breaking change notice on the release page of v9.14.1 as this broke prod for us ;) No idea how to propose that after the fact though.

    Reviewed by SeanDylanGoff at 2022-07-18 18:21
  • 10. Update docs to reflect User API

    I don't believe email or password are explicitly required by the API, but are needed to use the default auth provider.

    See: https://github.com/directus/directus/issues/14441#issuecomment-1185618730

    Reviewed by aidenfoxx at 2022-07-15 15:34
  • 11. Sending automatic email after user account creation

    Hi all, is there a solution for sending automatic mail to a new user account, including the username and password or an activation link (better security) ?

    Thanks in advance. Will Code

    Reviewed by will-code-for-pizza at 2022-07-15 10:37
  • 12. Configuration > Data Model 2/2

    TODO

    • [ ] Set page structure for Fields' sub-nested menus.
    • [ ] Approval from Ben + Rijk
    • [ ] field-types
    • [ ] Schema
    • [ ] Translations
    • [ ] Relationship
    • [ ] Field
    • [ ] Interface
    • [ ] Display
    • [ ] Validation
    • [ ] Conditions
    • [ ] Add Media
    • [ ] Proofedit 1
    • [ ] Submit for editorial review
    • [ ] Final Proofedit
    Reviewed by erondpowell at 2022-08-11 18:24
Directus-sql-panel - Directus panel component which shows result of stored SQL query as a table

directus-sql-panel Directus panel component which shows result of stored SQL que

Jul 13, 2022
Directus-extension-display-link - Display URLs with an open in new tab icon link in Directus 9
Directus-extension-display-link - Display URLs with an open in new tab icon link in Directus 9

directus-extension-display-link Display URLs with an open in new tab icon link i

Aug 8, 2022
A demo of a Full Stack blog site with CRUD operations using the MEVN stack

A demo of a Full Stack blog site with CRUD operations using the MEVN stack

Jul 10, 2022
Full-stack project - Website review Anime, Manga. MEVN Stack (Mongo-Express-Vue-Node).

Project Animan Lab Frontend stack: VueJS 3 VueX Axios Tailwind CSS SASS Editor: Quill Upload Image: Filepond Cloudinary Swiper Backend stack: NodeJS E

Apr 23, 2022
Guweb-next - a frontend from modern stack, gulag written with nuxt 🏘

Table of Contents Table of Contents What is guweb-nuxt? Requirements The team What is guweb-nuxt? guweb is the front-facing appearance of the osu! ser

Mar 15, 2022
🌕 Create beutiful docs in markdown and HTML from postman collection
🌕 Create beutiful docs in markdown and HTML from postman collection

Afterman Export beautiful docs in Markdown and HTML from postman collection ?? No Backend ?? No configuration ?? Customize the output of your document

Jul 29, 2022
Wiki made using nuxt.js content with the docs template

ultramarine-wiki WIP wiki page made using nuxt content and its docs template.

Jun 5, 2022
Filscan browser is the filecoin blockchain browser and data service platform,It provides one-stop data services such as mining ranking, blockchain data query and visualization chart based on filecoin
Filscan browser is the filecoin blockchain browser and data service platform,It provides one-stop data services such as mining ranking, blockchain data query and visualization chart based on filecoin

Filscan browser is the filecoin blockchain browser and data service platform,It provides one-stop data services such as mining ranking, blockchain data query and visualization chart based on filecoin

Jun 2, 2022
A modern lightweight design system, built on the principles of minimalism with inspirations from Scandinavian architecture, handcrafted for data intensive applications.
A modern lightweight design system, built on the principles of minimalism with inspirations from Scandinavian architecture, handcrafted for data intensive applications.

A modern lightweight design system, built on the principles of minimalism with inspirations from Scandinavian architecture, handcrafted for data intensive applications.

Mar 10, 2022
Simple Directus Extension that allows conditionally showing or hiding fields.
Simple Directus Extension that allows conditionally showing or hiding fields.

Directus Conditional Fields Simple Directus Extension that allows conditionally showing or hiding fields. Example Configuration used for the example:

Jun 22, 2022
Toko is an Open Source Jamstack e-commerce solution powered by NuxtJS (Front-End) and Directus (CMS).
Toko is an Open Source Jamstack e-commerce solution powered by NuxtJS (Front-End) and Directus (CMS).

Toko is an Open Source Jamstack e-commerce solution powered by NuxtJS (Front-End) and Directus (CMS). Toko focuses on four key points: Performances to give users fast loading time, low data consumption to improve the eco-conception, SEO-friendly content, and modern design templates.

Aug 3, 2022
Nuxt 3 starter for Directus with Tailwind CSS and lots of other goodies
Nuxt 3 starter for Directus with Tailwind CSS and lots of other goodies

Nuxt 3 / Directus Starter ⚠️ STILL WORK IN PROGRESS - COULD CHANGE DAILY ⚠️ Opinionated starter template for Nuxt 3 using Directus 9 as a backend. Dev

Aug 4, 2022
A Directus v9 Interface for generating a human-readable ID for a text or string field in a collection
A Directus v9 Interface for generating a human-readable ID for a text or string field in a collection

Directus Extension: dwaring87-interface-human-readable-id A Directus v9 Interface for generating a human-readable ID for a text or string field in a c

Jul 31, 2022
📚 Effortless documentation, done right.

ATTENTION: this project is no longer actively maintained (I still push some code once in a while), if you want to see improvements on this project, pl

Aug 3, 2022
Blockviz - A Cryptocurrency Market & Blockchain exploration, using on chain data combined with exchange data to get a sense of trends. 📊
Blockviz - A Cryptocurrency Market & Blockchain exploration, using on chain data combined with exchange data to get a sense of trends. 📊

Visualizations for Blockchain & Market Data Sample Block Start Development & Testing Locally Clone the repo and run npm install The repo development i

Apr 5, 2022
To avoid storing data on the server, the Wault password manager encrypts and decrypts data inside the browser
To avoid storing data on the server, the Wault password manager encrypts and decrypts data inside the browser

To avoid storing data on the server, the Wault password manager encrypts and decrypts data inside the browser. The keys for all encryption processes are derived from the password, which is never sent to the server.

Jul 16, 2022
GenVue is a hostable, web application that lets confidential users upload and share private files. Tech stack: Net Core 2.0 + Vue.js + Vuex + OpenIddict + Vuetifyjs + EF + SQLServer/Postgress
GenVue is a hostable, web application that lets confidential users upload and share private files. Tech stack: Net Core 2.0 + Vue.js + Vuex + OpenIddict + Vuetifyjs + EF +  SQLServer/Postgress

Asp.NETCore 2.0 Vue 2 with WebApi Authorization Starter template This repo contains an AspNetCore 2.1 + Vue.js 2 starter template (VS2017) + NetCore W

Jul 14, 2022
Simple full-stack application for arranging appointments for doctors.
Simple full-stack application for arranging appointments for doctors.

Let's Talk Simple full-stack application for arranging appointments for doctors. Technically just a demonstration of Python (FastAPI + SQLAlchemy) on

Nov 1, 2021