Skip to content

Add setup and installation instructions to README #31

@benaiah-muga

Description

@benaiah-muga

Problem

The GreenCode README lacks basic setup and installation instructions, making it difficult for new contributors to get started with the project.

Proposed Improvement

Add comprehensive setup instructions including:

  • Prerequisites (Java, Maven, PostgreSQL, Node.js, Docker)
  • Docker setup instructions (recommended method)
  • Local development setup without Docker
  • Production build instructions

Expected Benefit

New contributors will be able to quickly set up the development environment and start contributing to the project without needing to dig through source code or ask for help.

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