Problem
The README template has vague information about how to run the project locally. It explains the .env set up but it doesn't explain how to install dependencies, or how to run the project.
Solution
- Add a Running the project locally section in how-it-works.md explaining how to:
- Clone the repo
- Create a
venv and activate it
- Install dependencies
- Run the main function
- Delete the section in the README template.
Problem
The README template has vague information about how to run the project locally. It explains the
.envset up but it doesn't explain how to install dependencies, or how to run the project.Solution
venvand activate it