Skip to content

Latest commit

 

History

History
93 lines (69 loc) · 3.76 KB

README.md

File metadata and controls

93 lines (69 loc) · 3.76 KB

Larder Vault Project 🛒

🛍️ Larder Vault is a basic e-commerce platform designed for ease of use, featuring dual access for both administrators and customers. It provides a robust set of features for managing products, categories, carts, and sales analytics.

Author

About

I am a full-time student of IITM BS, currently in the diploma level of programming.

Project Description

Larder Vault is a comprehensive e-commerce platform built with Vue.js for the front end and Python-Flask for the back end. It allows users to manage their carts, make purchases, and offers enhanced control for administrators and store managers. The platform also provides graphical insights into sales data for strategic planning and performance analysis.

Demo Video

Watch Demo Video Here

Technologies Used

  • Python: Primary language for controller development and hosting the app.
  • Vue.js: Front-end development.
  • HTML: Creation of Vue components and templates.
  • Bootstrap: Enhancing front-end design and navigation.
  • SQLite: Database for the app.
  • Flask: Web framework of the app.
  • Flask-SQLAlchemy: Accessing and modifying SQLite database.
  • Flask-Celery: Handling asynchronous background jobs.
  • Flask-Caching: Caching API outputs for improved performance.
  • Redis: In-memory database for API cache and message broker for Celery.
  • Chart.js: Generating various charts.
  • Git: Version control management.
  • Unsplash: Sourcing Images

Architecture and Features

Larder Vault follows a client-server model with Vue.js for the front end and Python-Flask for the back end. It incorporates various features to provide a seamless e-commerce experience:

Dual Access with Enhanced Admin Control

  • Distinct Access Points: Separate access for customers and administrators.
  • Store Manager Signup: Streamlined signup process for store managers.
  • Approval System: Admin approval required for store manager actions to ensure quality control.

Shopping Cart Management

  • Convenient Cart Management: Customers can add, edit, or remove products before purchase.

Product and Category Management

  • Control: Administrators and store managers can manage product listings and categories.

Graphical Sales Analytics

  • Insights: Utilizing Chart.js to provide graphical insights into sales data.

User Authentication

  • Secure Access: Robust mechanisms for user signup and login.

Database Integration

  • SQLite: Used for database needs.
  • Flask-SQLAlchemy: Effective data handling.

Asynchronous Task Handling

  • Flask-Celery: Managing background tasks for optimized efficiency.

API Caching for Performance

  • Flask-Caching and Redis: Caching API outputs and in-memory database for improved performance.

Comprehensive RESTful API

  • Well-Structured: API for interacting with product data, user accounts, and other essential elements.

Responsive and Attractive UI

  • Bootstrap and Vue.js: Delivering a user-friendly and aesthetically pleasing interface.

High-Quality Imagery

  • Unsplash: Incorporating visually appealing images to enhance user engagement.

Installation

To install and run Larder Vault, follow these steps:

  1. Clone Repository: 
    git clone https://github.com/username/repository.git
  2. Install Dependencies: 
    cd <repository_directory>
pip install -r requirements.txt
npm install
  3. Run Application: 
    flask run

The application should now be running locally.

Access Application: Open your web browser and go to http://localhost:5000 to access the Larder Vault application.