Isoko

2021 Software Engineering Capstone - AWS Minority Owned Business Team

Visit the ALPHA Version of ISOKO here: https://master.db75ilqlzlmt4.amplifyapp.com/

Table of Contents

1. Overview
2. Vision Statements
3. Meet The Team
4. Onboarding Instructions
5. CI Server
6. Technical Specification Guide
7. Project Architecture

Overview

Despite making up 32% of the population, ethnic minorities own only 18% of businesses in the United States, and 99% of these businesses are small businesses. Additionally, women make up more than half of the population and represent only 19% of business owners, and members of the LGBTQIA+ community represent less than 1% of business owners. In order to help these minority business owners gain more traction and create an easy and accessible way for people to invest in individuals and their communities, we are creating a web application that allows users to search for businesses in their area that offer specific products and are owned by members of specific minority groups.

Vision Statements

For Business Owners

For business owners who are minorities Isoko is a web application that displays various minority owned businesses unlike Yelp/Google, our product strives to increase traction for minority owned businesses specifically .

For Consumers

For minority and socially conscious consumers who are looking to support minority owned businesses Isoko is a web application that displays various minority owned businesses unlike Yelp/Google, our product is not oversaturated and serves a specific need to find a variety of minority group owned businesses.

Meet the Team

(From left to right)

• Justin Poist
• Cole Perry
• Reilly Salkowski
• Rohith Dara
• Shriya Nimmagadda

Set-up/Onboarding Instructions

Prerequisites

1. Make sure to clone this repo by runnning git clone https://github.com/CPSECapstone/Isoko.git
2. Have node installed. (Preferably version 14.0.1 or later)
3. Have docker installed.
4. Have the AWS SAM CLI installed.
5. OPTIONAL If you are planning on deploying our AWS backend stack to your personal AWS account, make sure you have the AWS CLI installed and properly configured with your account details.

Setting up the Frontend

1. From the root directory, navigate to our frontend directory cd frontend/isoko/
2. Install all of our frontend dependicies npm i
3. To start your server, run npm start
4. Navigate to http://localhost:3000 to view the frontend

Setting up the Backend

1. From the root directory, navigate to our backend directory cd backend/isoko-backend/
2. Install all of our backend dependicies npm i
3. To start your backend server, run the command sam local start-api

Setting up the Test Environment

1. To run our frontend tests, navigate to our frontend directory cd frontend/isoko/

2. Then, run the command npm run cypress:open, to run our cypress tests.

3. To run our backend tests: From the root directory, navigate to our backend directory cd backend/isoko-backend/

4. Then, run the command npm test.

Deploying the Backend

1. To deploy the AWS backend stack to an AWS account, first ensure that your AWS CLI is configured with the account details you wish to deploy your stack to. You can check this by running aws configure list.
2. Then, navigate to our backend directory cd backend/isoko-backend/.
3. Next, build the SAM template by running sam build.
4. Finally, deploy the stack to your AWS account sam deploy.

CI Server

1. We are using AWS codebuild for continuous integration. You can view our build history here.

More Project Information

1. For more detailed information about our project's specifics, check out our Technical Specification Guide here.
2. For more details on our project's privacy policy, EULA, and contact information checkout our Github Pages/Alpha Site here.

Project Architecture