InternPulse/renergy-hub-java-backend

Java Backend API for Renergy Hub, An innovative Cleantech web platform designed to address Nigeria’s persistent electric power challenges by empowering users to optimize renewable energy consumption. # Renergy Hub Java Backend API ## Project Overview Live link: is at renergy-hub-java-backend-9.… Doc link: internpulse-9255.postman.co ## Installation Instructions ### Prerequisites Before setting up the project locally, ensure you have the following prerequisites installed: - Node.js (>=20.14.0). - A Database System PostgreSQL) ### How to run API Locally 1. Clone the repository: ```bash git clone github.com ``` 2. Change into the parent directory: ```bash cd property-hive-backend-two ``` 3. Set appropriate values for the following Compulsory Environment Variables: ```txt # Postgres connection string POSTGRES_DSN="" # Secret key for signing JWTs JWTKEY="" # API Port PORT=5000 ``` 4. Install the App dependencies: ``` bash npm install ``` 5. Start the App: ```bash npm run start-server ``` The API should now be running locally at localhost. # Commit Standards ## Branches - **dev** -> pr this branch for everything `backend` related - **main** -> **dont touch** this branch, this is what is running in production! ## Contributions property-hive-backend-two is open to contributions, but I recommend creating an issue or replying in a comment to let us know what you are working on first that way we don't overwrite each other. ## Contribution Guidelines 1. Clone the repo `git clone github.com`. 2. Open your terminal & set the origin branch: `git remote add origin github.com` 3. Pull origin `git pull origin dev` 4. Create a new branch for the task you were assigned to, eg `TicketNumber/(Feat/Bug/Fix/Chore)/Ticket-title` : `git checkout -b BA-001/Feat/Sign-Up-from` 5. After making changes, do `git add .` 6. …