Group N CS3203-001 Project: KYPER

Project Description

The project is a web-application that allows users to scan the barcodes of food items in stores and find out which companies are associated with the item, as well as allowing local businesses to promote their products to users in their communities. The app allows users to create personal and business accounts depending on their needs/purposes for using the application. Users with personal accounts should be able to create and name groups for specific businesses based on what they mean to the user, collecting all the products made by the businesses in said group. Users with business accounts should be able to upload their business and the products they produce to the database of the application, allowing users to access it ( this is temporary at the moment, I am curious about how to differentiate real businesses from fake ones).

Development Software

Built with:

• ReactJS 18
• Javascript ES13
• MySQL 8.0.36

  OS:

  Not applicable

To Run

In the terminal, click the split terminal button. On one side, cd into src. On the other, cd into backend.

In each split terminal, install dependencies using: npm install

For Frontend

Use command: npm start

For Backend

Use command: npm start

PR Requirements For Merging

• Code matches corresponding ticket/issue
• Ticket/Issue number attached on PR and in a comment within the code
• No node modules included in list of changed files
• Check for bugs/unnecessary code

Editing Instructions

• To access this repository locally, you can take the repository url and clone this repo by entering the following command in the desired repository:

git clone [https://repository-url.com]

• Then, once inside the repo, create a new branch before making any changes using the command:

git branch [new_branch_name]

• Once you've created a new branch, you can use the following command to "checkout" to that branch:

git checkout [branch_name]

• Then, any changes you make should be committed using:

git add [changed_file_name]

git commit -m "[commit message]"

• It's recommended that you commit each time you save your code.
• Once you have reached a stopping point in new changes to the code (finishing whatever task you were working on, fixing a bug, adding something new, etc.), push local changes to GitHub using (this may require a set-upstream command, which would be provided by terminal):

git push

• Once new commits have been pushed, you should go to the GitHub Repository and create a Pull Request. Make sure to include information about your changes, as well as screenshots of UI if applicable. Then, you should have at least one other contributor review your PR before the changes are merged into master.
• In order to update your local repo to include any new changes, you can use:

git pull

Roadmap

Development milestones and dates to reach those

Sprint 1 : 04/11

• Establish basic system architecture and automatic tests for basic features
• Fill public folder with images and resources necessary for front-end design

  Sprint 2 : 04/30

• Have main features ready and fully tested