Please use care when making edits. Open Issues, and work off branches before submitting PR's to merge in your changes.
When dealing with env and config files, there are example files with the structure set out. Contact me (Michael) to get the appropriate credentials to connect to the database and other services.
You will need to first install:
- Node.js
- Yarn
To install the project dependencies, execute the command yarn
in the root directory, then again in both the client
and api
directories.
To configure the project, edit values in the .env and config files.
To run either component of the project (client or api), look at the package.json
of each and view the scripts
available.
Run the scripts by using yarn run <script>
while in the same directory as the package.json
.
If you have any issues, let me know.