BizRank

A web application for rating the small businesses thriving across the internet. It also allows users to mark their favourite businesses, share them with their friends and family, enjoy the ongoing sale and set a reminder of the upcoming sale on their favourite brands.

• Tech stack
• Want to contribute
• Standard Commit Messages
• Before making PR
• Local Setup
• Backend setup
• Frontend setup

Tech stack

• Frontend: Single Page Application using React
• Server: Node.js for the server.

Want to contribute?

Standard Commit Messages

This project is using the conventional commits standard. Please follow these steps to ensure your commit messages are standardized:

• Commit messages should have this format: <type>[optional scope]: <description>
• Type should be fix(if fixed some bug), feat(if added new feature), docs(changes in documentation) or test(added new tests)
• Scope should be frontend or backend or global if your changes affects both.
• Description should be concise.
• Example: docs(global): CONTRIBUTING.md added

Note: All the commits should be made from the root directory of the repository

Before making PR

• Run npm run lint for checking lint errors.
• Run git fetch upstream & git rebase upstream/master to fetch updated codebase into your local repository before creating any new branch.
• Run git checkout -b <your-branch-name>

Local Setup

• Fork and clone the repository.
• Add remote upstream git remote add upstream https://github.com/varisha-025/BizRank.git

Backend setup

• Run cd server
• Run npm install to install all dependencies.
• Run node index.js to start server.

Frontend setup

• Run cd client
• Run npm install to install all dependencies.
• Run npm start to start the server and visit site.