-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #83 from CivicActions/docs/infra-codebase-structure
Docs: adds initial infrastructure/codebase structure content
- Loading branch information
Showing
1 changed file
with
55 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
# Repository overview | ||
|
||
## Codebase Structure | ||
|
||
``` | ||
π .ddev | ||
π config | ||
π docs | ||
|- π docs | ||
|- docusaurus.config.ts | ||
|- sidebars.ts | ||
π src | ||
|- π frontend | ||
π tests | ||
|- π cypress | ||
|- π e2e | ||
π web | ||
``` | ||
|
||
### [Local development](/development/local) with DDEV | ||
|
||
π **.ddev** | ||
- Configuration for [DDEV](https://ddev.readthedocs.io/en/stable/) | ||
|
||
### [Drupal](/development/back-end) | ||
|
||
The following directories support the installation of the Drupal content management framework. | ||
|
||
π **web** | ||
- This is the docroot of the Drupal installation | ||
|
||
π **config** | ||
- Storage of `*.yml` configuration management files for Drupal | ||
|
||
### [NextJS Front End](/development/front-end) | ||
|
||
π **src/frontend** | ||
- This is the docroot of [NextJS](https://nextjs.org/) front end. | ||
|
||
### Documentation | ||
|
||
π **docs** | ||
- Project documentation powered by [Docusaurus](https://docusaurus.io/). | ||
- Source files are in `π docs/docs/` | ||
- See `π docs/sidebars.ts` for configuring the left-side navigation in the Docusaurus UI. | ||
|
||
### Tests | ||
|
||
π **tests** | ||
- Includes the configuration for end-to-end tests written with [Cypress](https://www.cypress.io/). | ||
- See `π tests/cypress/e2e/*cy.js` for individual tests. | ||
- [More about tests](/development/local/cypress) |