The Pedmonie Express Backend API is a Django-based analytics service designed to provide insights into critical business areas, including:
- Sales Performance Analytics
- Revenue Trends: Track overall sales performance over time (e.g., daily, weekly, monthly, quarterly). Show revenue growth or decline trends to help vendors understand performance.
- Sales by Product: Display which renewable energy products (solar panels, wind turbines, batteries, etc.) are generating the most revenue.
- Sales by Region/Location: Identify which geographic areas or markets are generating the most sales, useful for targeting specific regions.
- Sales by Time of Year: Renewable energy products may have seasonal trends (e.g., increased sales in summer for solar products). Track sales spikes or dips during different times of the year.
Live link: is at https://renergy-hub-express-backend.onrender.com
Doc link: https://documenter.getpostman.com/view/36548151/2sAYBPmZm1
Before setting up the project locally, ensure you have the following prerequisites installed:
- Node.js (>=20.14.0).
- A Database System (e.g., PostgreSQL, MySQL, SQLite)
- Clone the repository:
git clone https://github.com/InternPulse/pedmonie-express-backend.git- Change into the parent directory:
cd pedmonie-express-backend- Set appropriate values for the following Compulsory Environment Variables:
# Postgres connection string
DATABASE_URL=""
# Secret key for signing JWTs
JWTKEY=""
# API Port
PORT=5000- Migrate Your Database:
npx prisma migrate dev --name init- Install the App dependencies:
npm install- Start the App:
npm run devThe API should now be running locally at http://localhost:5000/.
- dev -> pr this branch for everything
backendrelated - main -> dont touch this branch, this is what is running in production!
pedmonie-express-backend 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.
- Clone the repo
git clone https://github.com/InternPulse/pedmonie-express-backend.git. - Open your terminal & set the origin branch:
git remote add origin https://github.com/InternPulse/pedmonie-express-backend.git - Pull origin
git pull origin dev - 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 - After making changes, do
git add . - Commit your changes with a descriptive commit message :
git commit -m "your commit message". - To make sure there are no conflicts, run
git pull origin dev. - Push changes to your new branch, run
git push -u origin feat-csv-parser. - Create a pull request to the
devbranch notmain. - Ensure to describe your pull request.
-
If you've added code that should be tested, add some test examples.
Under any circumstances should you merge a pull request on a specific branch to the dev or main branch
| Type | Description | |
|---|---|---|
| feat | Features | A new feature |
| fix | Bug Fixes | A bug fix |
| docs | Documentation | Documentation only changes |
| style | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.) |
| refactor | Code Refactoring | A code change that neither fixes a bug nor adds a feature |
| perf | Performance Improvements | A code change that improves performance |
| test | Tests | Adding missing tests or correcting existing tests |
| build | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| chore | Chores | Other changes that don't modify, backend or test files |
| revert | Reverts | Reverts a previous commit |
Sample Commit Messages
chore: Updated README file:=choreis used because the commit didn't make any changes to the backend or test folders in any way.feat: Added plugin info endpoints:=featis used here because the feature was non-existent before the commit.