diff options
| author | HampusM <hampus@hampusmat.com> | 2021-08-02 22:44:45 +0200 |
|---|---|---|
| committer | HampusM <hampus@hampusmat.com> | 2021-08-02 22:44:45 +0200 |
| commit | ca109b210924a14343870a887c28300c833bcc45 (patch) | |
| tree | d7c2bd60ab60f948796301e85610376e73b812e4 /documentation/hacking.md | |
| parent | bc523758434a2376bb9c469b5259d82ceb1cda03 (diff) | |
Added documentation & bumped the typedoc-theme-slick-dark dependency version
Diffstat (limited to 'documentation/hacking.md')
| -rw-r--r-- | documentation/hacking.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/documentation/hacking.md b/documentation/hacking.md new file mode 100644 index 0000000..81a806c --- /dev/null +++ b/documentation/hacking.md @@ -0,0 +1,20 @@ +## The project structure +Githermit is what's called a monorepo and is thereof comprised of multiple packages. All of which resides in the 'packages' directory. + +### Server +This package contains the backend. The brains of the operations.<br> +You can find extensive information about the internals of the backend [here](/docs/modules.html) + +### Client +This package contains the frontend. Written is Vue.js, this is the soul of the project. + +### API +This package contains interfaces and types shared by the server and client packages. + +### Eslint-config-base +This package contains a base Eslint configuration for the server and client packages. Aswell as for the test environment. + +## Development utilities +You can use the following command to run a live-updating instance of Githermit. + +`$ yarn dev` |