diff --git a/Development.md b/Development.md new file mode 100644 index 0000000..83e7b0d --- /dev/null +++ b/Development.md @@ -0,0 +1,129 @@ +# Development Guide + +Welcome to the Tildes Issue Log development guide, this will be very concise. + +## Setup + +1. Clone the repository. +1. Create a `config.json` file from the sample `config.sample.json` file. The `gitlabToken` should be [a Personal Access Token](https://gitlab.com/profile/personal_access_tokens) with the `api` scope available. + +## Project Overview + +The Tildes Issue Log is set up with 7 scripts, 6 of which can be run on their own. + +If you want to run any of these on their own, use `yarn ts-node 'source/scripts/