A repo to manage the settings of the Code and Coffee Service.
Includes a validation system to ensure that the settings are always valid and to reduce the change of errors caused by misconfiguration.
There are two environments for the Code and Coffee Service:
- "Production" is the main environment and is what the Code and Coffee homepage runs off of. It is in our best interest that this environment stays as stable as possible.
- "Development" is our development environment. It is meant for us to play around with and break from time to time. Where we can test ideas out with little penalty.
These two environments have two separate sets of settings to enable stability in Production while allowing for creative bodging in Development. These settings can be found in the production and development branches respectfully. These two branches do not need to always be in sync.
To update the settings see Updating Settings Workflow in workflow.md.
For a description of all the settings see settings.md.
NodeJS - Used to run javascript that does the settings validations.
Typescript - Adds typing to the code to make it easier to read and maintain.
TS-Node - Used to run typescript code in node without having to transpile.
prettier - Used to organize the code to make it easier to read and maintain.
ESLint - Used to enforce code standards to make it easier to read and maintain.
React - Used to build the web components. Makes it easier to build interactive and reactive components.
GitHub Actions - The server that runs the validation code.
GitHub - Used to store the code and manage the project.
JSON Type Definition - Used to create schemas for the settings to validate against.
ajv - Used to validate the settings against the schemas.
./settings
Directory containing the settings for the Code and Coffee Service.
./schemas
Directory containing the schemas for the settings.
./readme
All the resources that are used in the readme.md file.
./readme
Configuration for the github repo, mainly the automatic workflow that triggers validation on commit.