Skip to content

[ENHACEMENT]: Add how to run the project locally info in docs/how-it-works.md #72

@drkrillo

Description

@drkrillo

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomerssize 2Requires modification in more than one file.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions