anaskhan0607 / bizreach

final-project-s23-cd-users-baddies created by GitHub Classroom

BizReach

BizReach is an online platform used to connect nearby mobile businesses to customers in need of their services. It allows users to browse a variety of different services and businesses to view local customers in need of their services. Payments can be made directly on BizReach, which offers a simple and secure transaction.

The primary motivation of BizReach is to help customers easily find reliable businesses who are in need of their service without doing hours of research. We also strive to help talented small business owners gain a clientele without spending hundreds or thousands of dollars on advertising.

BizReach is built using React, Firebase, Node.js and Express. FERN has been chosen as the framework to construct this app because of its potential to create high-quality web applications with a single codebase, regardless of the OS of the device. This stack is also relatively easy to learn for developers with experience with object-oriented programming languages like Python, Java, etc and provides. Firebase also provides an authentication service which will be integrated in the platform

Installation

BizReach is designed with the latest tools and frameworks which will make developing and contributing to the web application easy. This section will guide you to setup BizReach on your local device. Please follow the steps provided below to get started.

Prerequisites

Before proceeding with installation, please ensure your device has the following software and tools installed:

• Node.js
• A text editor such as VSCode or an IDE compatible with Flutter (e.g. Android Studio or XCode)
• Chrome

Installation Steps:

1. Clone the repository to your local machine by pasting the following command in your terminal:

HTTPS:
git clone https://github.com/CSCC012023/final-project-s23-cd-users-baddies.git

SSH:
git clone [email protected]:CSCC012023/final-project-s23-cd-users-baddies.git

2. Navigate to the project directory using the following command:

cd final-project-s23-cd-users-baddies

3. Execute the following command from the root directory to install the dependencies:

npm run install

4. Execute the following command from the root directory to run the project:

npm run start

There you go! You now have BizReach running on your local machine. Good Coding!

Contribution

The process to contribute to this project will follow the traditional Git flow workflow. The purpose to contribute to this project is continue innovating the platform making it faster and easier to use. The information provided below is how you can be a part of this journey in improving BizReach!

1. Branch Naming Conventions: When there is an issue, you will create a new branch to start working on the issue. Name your branch starting with your utorid followed by the issue number and the issue summary.

git checkout -b <utorid>-<issue_number>-<issue_summary>

2. Issues: Please create an issue on GitHub issues until Jira gives permission to integrate our GitHub repository to our Jira project. Issues will be used for any major changes. Tickets will be created under the correct Sprint/Epic and moved across the ticket board as you progress in your work. Remember to update tests accordingly as well.

3. Finished the Issue? When you believe you have resolved the issue, submit your changes for a pull request. Once it has been reviewed by other contributors and the request has been approved, please proceed with Squash and Merge option into the main branch. Congrats! You are now a contributor to BizReach!