Skip to content

Readme needs more information #23

@m4v15

Description

@m4v15

relates #22 #20

All readme's should have a minimum:

  • Link to the live site
  • Short explanation of what is in the repo.
  • Explanation of how to run the repo locally. This should include instructions such as:
    • clone the repo
    • run npm i
    • run whatever the script is to run in developer mode
    • instructions on what to put in a config.env file - this needs to include the variable name, and the type of variable - eg 'create a config.env file and put in a postgres database url, giving it the name DB_URL'
    • instructions on how to build the database

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions