Skip to content

Documentation: Update README.md #99

Description

@favillat

Description

Currently README is outdated and unhelpful for new members/ anyone who hasn't interacted with Dashboard.

  • Add concise yet informative intro section.
  • Add "getting started" section.
    • walks through front end setup.
    • walks through backend API set up.
  • Added Contacts section, @favillat for example.
  • Add a "building" section
    • walk through compiling project.
    • running said production app.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomerspriority: lowLow impact, easily resolved.type: documentationImprovements, additions, or updates to documentation.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions