search

Schefflera-Arboricola / Grocery-Store

A multi-user (customer, store manager, delivery executive, developer) e-commerce web app to manage a grocery store, build using Flask framework and SQLite database.
Creative Commons Zero v1.0 Universal
0 stars 0 forks source link
crud-api docker ecommerce-website flask flask-login flask-restx flask-sqlalchemy hacktoberfest javascript sqlite stripe-api swagger-api tfidf twilio-api workflow

readme

New Repo - contains further development

About

It's a multi-user (customer, store manager, delivery executive, developer) e-commerce app to manage a grocery store, made using Flask framework and SQLite database. It can be used to search and query products and place orders by customers, manage product inventories and different categories by the store manager, and manage deliveries by the delivery executive. The developer can use the CRUD APIs for products and categories using their private API keys. Each folder has a README.md file except static and templates folders. The ScreenFlow folder has screenshots of the website and shows the flow for all users(except developer).


Features :

  1. 4 types of users: Customer, Store Manager, Delivery Executive, Developer
  2. CRUD APIs for Product and Category management(flask_restx) - You can play around with the API endpoints by pasting the contents of application/APIdoc.yaml file in Swagger Editor
  3. Proper authentication and authorization framework(flask-login)
  4. External APIs: Stripe for online payments, Twilio for OTPs
  5. Ability to search Products based on category, ratings, and various other product features
  6. Product recommendation systems for customers based on their previous orders and for showing similar products of a given product based on product description.


How to run the code :

Running the code:

  1. git clone https://github.com/Schefflera-Arboricola/Grocery-Store.git
  2. cd Grocery-Store
  3. get API credentials for Twilio from here and for Stripe from here

using virtual environment :

  1. set up your API credentials in sh local_run.sh file
  2. In application/config.py file, in the LocalDevelopmentConfig class comment the SQLITE_DB_DIR initialization for docker and uncomment for the virtual environment
  3. sh local_setup.sh
  4. sh local_run.sh
  5. open http://127.0.0.1:8080 in the browser to view the website

using docker :

  1. set up your API credentials in .env file
  2. docker-compose up --build
  3. open http://127.0.0.1:8080 in the browser to view the website

* If you get any keyword error, go to inspect and try deleting the cookie data


Test users' login credentials for all types of users :

(Change the customer's phone number to the number you want to receive the OTP on, using the 'Edit Profile' option on the dashboard)


Feel free to make any issues/PRs to better the project.