Shopping Buddy

An awesome shopping assistant web application!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Demonstration
2. Getting Started
   • Installation
   • Execution

About the Project

This repository contains the source code of a full-stack web application for shopping assistance. The frontend was implemented using React.js, and the backend was implemented using .NET 7. The code is divided into 2 main folders:

• "./ShoppingBuddyApi" - backend;
• "./shopping-buddy-app" - frontend.

Demonstration

demo-video.mp4

Home

Search

Unavailable shopping item

Success

Shopping list

Getting Started

Follow the instructions bellow to get local copy up and running.

Prerequisite

1. Local MySQL server
2. .NET 7 SDK
3. Node.js

Installation

1. Clone the repository with the following git cli command

git clone https://github.com/mkokor/shopping-buddy.git

2. Get your local MySQL server up and running at port 3306 and make sure to enable following credentials

{
  "user": "root",
  "password": "password"
}

3. Make sure you have installed dotnet-ef tool

dotnet tool install --global dotnet-ef

4. Run following cli command inside of "./ShoppingBuddyApi/ShoppingBuddy.API" folder to apply database migration

dotnet ef database update

5. Run following cli command inside of "./shopping-buddy-app" folder install required NPM packages

npm install

Execution

Run command below inside of "./ShoppingBuddyApi/ShoppingBuddy.API" folder to start the backend.

dotnet watch run

Run command below inside of "./shopping-buddy-app" folder to start the frontend.

npm start

After startup, application can be accessed on following domains:

• http://localhost:5122/swagger/index.html - API Swagger UI;
• http://localhost:3000/ - application home page.