README: List important files and modules (without explanation yet)

This commit is contained in:
fr33domlover 2022-09-24 09:12:45 +00:00
parent be95f15b21
commit 40e2dd9666

View file

@ -242,6 +242,8 @@ code. `NEWS.md` provides a friendly overview of the changes for each release.
## Finding your way in the codebase
Folders:
- `app`:
*main* functions of the web app, for regular build and for development modes
- `config`:
@ -270,6 +272,37 @@ code. `NEWS.md` provides a friendly overview of the changes for each release.
- `th`:
Domain-specific language snippets, from which code is generated using TH
Files:
- `_boring`
- `th/routes`
- `th/models`
- `update-deps.sh`
- `bindist.sh`
Haskell modules in `src`:
- Non-`Vervis` modules:
- Modules ending with `Local`:
- The rest:
- `Vervis.Data`
- `Vervis.Persist`
- `Vervis.Fetch`
- `Vervis.Query`
- `Vervis.Web`
- Primary web app support modules:
- `Vervis.Foundation`
- `Vervis.Application`
- `Vervis.Settings`
- `Vervis.Model`
- `Vervis.Migration`
- Primary web app logic modules:
- `Vervis.API`
- `Vervis.Federation`
- `Vervis.Handler`
- `Vervis.Client`
- `Vervis.Ssh`
## Reporting Bugs and Suggesting Features
If you found a bug, or you have an idea, a feature request or a wishlist item,