yeboah326 / garage97

A web app for managing inventory

simplified-inventory-management-assistant

A web app for managing inventory

Project Setup

Needed software

• Python 3.8.5
• npm
• VSCode
• Draw.io Integration :VSCode Extension

Install node modules

npm install

Install pipenv on your system

pip install pipenv

Install packages (including dev)

cd sima_web_api
pipenv install --dev

Run this instruction to install the packages (including dev packages) associated with the project

Install all packages (no dev packages)

cd sima_web_api
pipenv install

Run this to install all the packages without the dev packages

Create a MySQL database instance

CREATE DATABASE database_name;

Add environment variables in the root of the project folder

touch .flaskenv .env

Add these lines to the .flaskenv file

FLASK_APP=run.py
FLASK_ENV=development
FLASK_RUN_PORT=9000

Add these lines to the .env file. Replace username, password and database_name with their respective values

MYSQL_USERNAME = username
MYSQL_PASSWORD = password
MYSQL_SERVER = localhost
MYSQL_DATABASE_NAME = database_name
SECRET_KEY=generated_key

SECRET_KEY can be generated using

import secrets
secrets.token_hex(32)

Perform database migrations

cd sima_web_api/
flask db init
flask db stamp head
flask db migrate
flask db upgrade

Start the api

npm run api

Start the react web app

npm run start

garage97's Issues

Create new stock

Create new stock in an existing stock list
Data format is a list of individual stocks
Same as new sale in an existing sale

StockList Data

date_created
total quantity
stock_list_id
total_price

Update Project Overview Info

• Update project overview info

Design splash page

• Design splash page

CORS

• Work on the CORS for react-flask

Status Codes

• Use appropriate status codes for various API endpoints

Write tests for various endpoints

Project Structure

I was thinking of using the file structure stated in this article for our project

Create and write tests for customer endpoints

Use doc string generator for proper code documentation

Modify UML to reflect changes in database

• Modify UML to show Stock_List
• Modify UML to show Sale_List

Status Codes

• Use appropriate status codes for various API endpoints

Use try except for better error handling

Create Stock section of the API

Tasks

• Create stock model
• Create stockList model

API Endpoints to create
Stock

• Get stock by id
• Get all stock
• Create new stock
• Update stock by id
• Delete stock by id
• Delete all stock

StockList

• Get stockList by id
• Get all stockList
• Create new stockList
• Update stockList by id
• Delete stockList by id
• Delete all stockList

Work on user based APIs

• Create endpoints for user login
• Create endpoint to create new users
• Create endpoint to get user by id
• Create endpoint to get all users
• Create endpoint to update user info
• Create endpoint to delete user

Add API Documentation

• Add API Documentation

Add environnement configuration

• Add instructions for the creation of env and flaskenv files

Fix react hooks errors

The following error is shown in the terminal
Line 42:7: React Hook useEffect has a missing dependency: 'fetchData'. Either include it or remove the dependency array react-hooks/exhaustive-deps

Return product_id in json data for get_all_product

Sale List Data Format

Return sale_id, total quantity of products sold, total price, date created

Report EndPoints

Create end points for retrieving the various data for the generating the report

Add Business API endpoint to front end

• Get all businesses endpoint
• Create business endpoint
• Log in to a business endpoint

Fix issue react routing

Create nested route for pages under business

Create endpoint to send report data

Send business data through endpoint

• Total sales made
• Total stock made
• Profit/Loss Made
• Sales and Stock made per product

Send product data through endpoint

• Total Sales Made
• Total Stock Made
• Stock remaining
• Profit/Loss made
• All sales
• All stock

Remove completed todos from the code

Write API Documentation

Tasks

• Product
• Sale
• Sale List
• Stock
• Stock List

Create Product Section of the API

Tasks

• Create product model

API Endpoints to work on

• Get all products
• Get product by id
• Create new product
• Delete product by id
• Update product by id

complete the stocks page design

• finish up stock page functionality
• apply to sales page design

Add product description to product models

Add the description to json data when get product is called

Update requirements engineering

• Update requirements engineering with current data

Create page to display the generated reports

• Design report with XD (Business, Product)
• Design the report page in react (Business, Product)
• Retrieve data from endpoint and display it
• Pass url to report endpoint to generate PDF

Add instructions on how to generate secret key

Design the SIMA Logo

• Design SIMA logo

Create Sale section of the API

Tasks

• Create sale model
• Create saleList model

API Endpoints to create
Sale

• Get sale by id
• Get all sale
• Create new sale
• Update sale by id
• Delete sale by id
• Delete all sale

SaleList

• Get all saleList
• Get saleList by id
• Create new saleList
• Update saleList by id
• Delete saleList by id
• Delete all saleList

API endpoint

Use for API endpoint : http://yeboah326.pythonanywhere.com/

Remove time field from date created field

Work on business APIs

• Create business model
• Get all businesses
• Get business by Id
• Create new business
• Update business info
• Delete businesses
• Delete business by id

Query Parameters

Create query parameters for retrieving the stocklists and salelists 10 at a time

Create login and registration pages

• Create login page
• Create registration page

Add report generator(in pdf format)

Convert html pages to pdf

Split files

• Split various components into folders
• Split index.css into small manageable files

Convert the api token keys to bearer token keys

Delete product

Fix Delete product not deleting due to referential integrity error

Fix icons not showing

• Fix icons not showing

Storing images

Storing profile picture in database
Endpoints for retrieving picture for frontend

Modify README.md to contain relevant project information