Githermit is what's called a monorepo and is thereof comprised of multiple packages. All of which resides in the 'packages' directory.
This package contains the backend. The brains of the operations.
You can find extensive information about the internals of the backend here
This package contains the frontend. Written is Vue.js, this is the soul of the project.
This package contains interfaces and types shared by the server and client packages.
This package contains a base Eslint configuration for the server and client packages. Aswell as for the test environment.
You may want to add the following to your settings.json
"dev": {
"port": (Port for the Vue.js development server)
}
You can use the following command to run a live-updating instance of Githermit.
$ yarn dev
Contributing your code should be done through the mailing list.
Here's some guidelines for a higher possibility of a merge.
- Write short & descriptive commit messages that follow the Conventional Commits specification
- Make separate commits for logically separate changes.
- Sign off your patches