aboutsummaryrefslogtreecommitdiff
path: root/docs_src/hacking.md
blob: 81a806c8b4b60c66320a2064ee1e3d393a3dce39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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.
You can find extensive information about the internals of the backend here

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