InternPulse/renergy-hub-go-backend

Go 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 Go Backend API This is the notification service for Renergyhub built in Go ## Project Overview Live link: is at renergyhub.osinachi.me Doc link: renergyhub.osinachi.me ## Installation Instructions ### Prerequisites Before setting up the project locally, ensure you have the following prerequisites installed: - Go (>=1.20). - A Database System (e.g., PostgreSQL, MySQL, SQLite) ### How to run API Locally 1. Clone the repository: ```bash git clone github.com ``` 2. Change into the parent directory: ```bash cd renergy-hub-go-backend ``` 3. Create the .env file from the .env.example file ```sh cp .env.example .env ``` 4. Set appropriate values for the following Compulsory Environment Variables in the .env file: ```.env PORT=7500 DB_HOST="localhost" DB_PORT="5432" DB_NAME="renergybackend" DB_USER="renergyuser" DB_PASSWORD="go-is-cool" DB_SSL_MODE="require" JWT_SECRET="" ``` 5. Install the App dependencies: ```bash go get ``` 5. Start the App: ```bash go run main.go ``` The API should now be running locally at localhost. ## Features 1. Send order created notification 2. Send email verification notification 3. Send order shipped notification # 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 …