Skip to content

Commit

Permalink
Merge pull request #83 from CivicActions/docs/infra-codebase-structure
Browse files Browse the repository at this point in the history
Docs: adds initial infrastructure/codebase structure content
  • Loading branch information
vauxia authored Feb 11, 2025
2 parents 5c7a2a9 + 21c01c4 commit 898c1ca
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions docs/docs/development/local/repository.md
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)

0 comments on commit 898c1ca

Please sign in to comment.