Include local development instructions in README - Githubissues

bcgov / AppAssessment

Components to automate the delivery of the App Assessment tool

Apache License 2.0

7 stars 3 forks source link

Include local development instructions in README #37

Open ty2k opened 2 years ago

ty2k commented 2 years ago

To assist Platform Services Team developers working with AppAssessment, add details about how local development should work in the README.

Include:

What permissions are needed in a given OpenShift namespace to run AppAssessment successfully?
What does the AppAssessment installation command look like if you want to generate a report using local changes?
- Ex: python3 ./build/report.py -n <namespace> -o ./build/report.html
How should you install the Python dependencies locally?
- Ex: Does ./build/requirements.txt file need to be used?

Definition of done

[ ] ./README.md is updated to include the information above.