Skip to content

docs: Add Getting Started / Setup instructions to README #56

@Noel24Dav

Description

@Noel24Dav

The README currently lists features and project structure but provides no guidance on how to actually run the project. A developer cloning this repository for the first time has no way to get the application up and running without digging through the source code themselves.
What's missing:

Prerequisites (Java version, Node.js version, Docker, PostgreSQL)
Steps to run the Spring Boot backend locally
Steps to run the React frontend locally
How to configure environment variables (.env is referenced but never explained)

Suggested fix:
Add a ## Getting Started section covering both the backend and frontend setup, along with a note pointing to an .env.example file for required environment variables.
Priority: High this is a blocker for any new contributor onboarding.

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