Skip to content

setup and installation instructions#38

Open
snowvirus wants to merge 1 commit intobos-com:mainfrom
snowvirus:readme
Open

setup and installation instructions#38
snowvirus wants to merge 1 commit intobos-com:mainfrom
snowvirus:readme

Conversation

@snowvirus
Copy link
Copy Markdown

I have added setups, instructions and all directions to help new contributors to know more about the project and how they can start contributing
This solves issue #31

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 23, 2026

@snowvirus is attempting to deploy a commit to the mukisalivingstone133-9917's projects Team on Vercel.

A member of the Team first needs to authorize it.

@snowvirus
Copy link
Copy Markdown
Author

@kmuwanga83 a review is required here

Copy link
Copy Markdown
Contributor

@RonaldRonnie RonaldRonnie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @snowvirus .
Thanks for the good work.
you could consider resolving the conflicts to have this in
thank you

Comment thread README.md
## Prerequisites

---
Install the following tools before setup:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you consider adding commands that someone could use to install these dependencies

Comment thread README.md
- Maven 3.9+
- Docker Engine + Docker Compose plugin (`docker compose`) for containerized setup
- PostgreSQL 15+ (for local non-Docker PostgreSQL workflow)
- Node.js 20+ (optional for future frontend work)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be removed since the this repo is for strictly API. For frontend we have esm-greencode

Comment thread README.md

For production, configure PostgreSQL credentials via environment variables (or externalized Spring config) before startup.

## Project Structure
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\you could consider use of a mermaid here to come up with the structure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants