mirror of
https://github.com/directus/directus.git
synced 2026-01-24 18:38:08 -05:00
817ccf3620
* Add Quickstart Guide * Update installation * Remove unused files * Update support/backing * Tweaks in concepts * Setup file structure for API reference 2.0 * Setup page layout for reference * Add clean-urls plugin * getting started updates * Finish authentication rest * getting started updates * Render stylus in 2 spaces * Various * Various * Finish activity docs * Add collections reference * Add extension reference * concepts updates * Fields/tweaks * Add files doc * Add revisions * concepts docs * More api reference * Finish rest api reference (finally) * initial concepts * More things * Add assets api ref * Move sections from file to assets * Add environment variables * contributing docs * Add field transforms page * Left align table headers * concept links * Add API config * Fix mobile nav * Add migrating a project * doc link fixes Co-authored-by: Ben Haynes <ben@rngr.org>
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
# Codebase Overview
|
|
|
|
> **The core concepts behind Directus are simple, however the problems that must be solved to honor them can be remarkably complex.** We strive to design and engineer the most elegant solutions possible, so that our codebase remains accessible.
|
|
|
|
## Node Monorepo
|
|
|
|
The primary Directus repository is located at [`directus/directus`](https://github.com/directus/directus) and houses the Admin App (Vue.js 3), API (Node.js), project documentation (Markdown), API Specification (OpenAPI), and other smaller packages used internally. Directus follows a monorepo design similar to React or Babel — this page will outline our monorepo's design and structure.
|
|
|
|
## `/api`
|
|
|
|
Contains the Directus API (REST+GraphQL), written in node.js.
|
|
|
|
#### `/api/dist` — Does this look OK as a heading? Or should it be a description.
|
|
|
|
#### `/api/extensions`
|
|
|
|
#### `/api/src`
|
|
#### `/api/uploads`
|
|
|
|
|
|
## `/app`
|
|
|
|
Contains the Directus Admin App, written in Vue.js 3.
|
|
|
|
## `/docs`
|
|
|
|
Contains all the platform's documentation, written in markdown with additional VuePress formatting.
|
|
|
|
## `/packages`
|
|
|
|
TK
|
|
|
|
## `/`
|
|
|
|
The root of the project contains the following noteworthy files.
|
|
|
|
- **`.editorconfig`** — TK
|
|
- **`code_of_conduct.md`** — TK
|