The README right now assumes the reader is an intermediate developer and has a good understanding of how the project works. I propose adding more details to make the README more beginner-friendly. @krook feedback welcome.
Add details to generate service credentials for App ID in the readme
All file routes should be relative to the README file. So for example /api-main/.env.example should be pyrrha-dashboard/api-main/.env.example. Alternatively, the readme should ask the user to change to the pyrrha-dashboard directory.
This assumes everything is running in a local development environment on a single localhost, if you are deploying the services separately, update the proxy and CORS settings in src/setupProxy.js: explain what the proxy does and why the user needs to update it when running each service separately.
Run yarn install to pull in all required packages. where does the user run this command? This needs to be run in each of the directories; pyrrha-dashboard, and pyrrha-dashboard/api-auth
There are a lot of steps in the following instruction:
- Start the back-end Flask API services with the command in the `package.json` file set of NPM scripts, in this case `start-main-api`. This will launch a server on port 5000, proxied through the front end port 3000 for the `/api-main/v1/` path. If you
- haven't yet installed a Flask environment, run `python3 -m venv venv; . venv/bin/activate; pip install -r requirements.txt`.
Divide into the following (need to test):
- cd into `pyrrha-dashboard/api-main`
- create the python virtual environment `python3 -m venv venv`
- activate the virtual environment `venv/bin/activate`
- install dependencies: `pip install -r requirements.txt`
- cd out to the main directory
- run `yarn run start-main-api`
7. The other steps can also be simplified similarly.
8. The following sections are not being used. I propose we remove from the readme and clean the code up later:
The README right now assumes the reader is an intermediate developer and has a good understanding of how the project works. I propose adding more details to make the README more beginner-friendly. @krook feedback welcome.
generate service credentials for App IDin the readme/api-main/.env.exampleshould bepyrrha-dashboard/api-main/.env.example. Alternatively, the readme should ask the user to change to thepyrrha-dashboarddirectory.localhost, if you are deploying the services separately, update the proxy and CORS settings insrc/setupProxy.js: explain what the proxy does and why the user needs to update it when running each service separately.yarn installto pull in all required packages. where does the user run this command? This needs to be run in each of the directories;pyrrha-dashboard, andpyrrha-dashboard/api-auth/events) - List, edit, add, delete events./devices) - List, edit, add, delete devices./firefighters) - List, edit, add, delete firefighters./profile) - Show's the read only view of the logged in user.