How siddhiparkar151992/online-book-store works
Project Type and Purpose
• This is a full-stack Online Book Store application.
• Frontend: Angular/Bootstrap single-page app (served as static assets by Flask).
• Backend: Python Flask REST API (server.py, bookstore/app.py).
• Data Stores: MySQL (primary), with a MongoConnection hook (optional) and in-memory Trie for search optimizations.
• Features: Book catalog, search, categories, cart, wishlist, orders, payment, shipment, user auth.
File Structure Analysis
Top-level
• server.py / setup.py – entry point and packaging.
• db/ – SQL scripts + exportdb.py for schema and seed data.
• bookstore/ – application package:
– app.py, config.py – Flask app initialization & config.
– index.html – main HTML shell.
– static/ – compiled Angular assets, CSS/SCSS, images, JS components, templates.
– templates/ – Flask-served HTML views (index).
– src/ – Python source split by domain:
· Database (DBConnection, MongoConnection)
· Trie (search index structure)
· auth, book, cart, category, order, payment, shipment, wishlist – each with Api classes and Dao classes.
· models/core/business – domain entities & repositories.
· config – parameter classes and constants.
README Insights
• Uses Python/Flask REST, MySQL 5.7+ (full-text search).
• Angular modules for UI, responsive design.
• Data structures (Trie) for performance.
• Modules: cart, wishlist, payment, order, search, categories.
a. Main Components
1. Client Browser (Angular SPA)
2. Flask REST API (Python)
3. MySQL Database
4. (Optional) MongoDB via MongoConnection
5. In-memory Search Engine (Trie)
6. External Services / Payment Gateway (if any)
b. Relationships & Data Flow
• Browser ↔ HTTP(S) ↔ Flask API endpoints (AuthApi, BookApi, CartApi, etc.).
• Flask services use DAOs → SQL queries on MySQL (and/or Mongo).
• On startup, Flask loads Trie module to index books for fast text search.
• Frontend angular services call REST endpoints then update UI templates.
• DB scripts in db/ define schema; setup.py installs the package; server.py starts Flask.
c. Architectural Patterns & Principles
• Separation of Concerns: Static Angular assets vs. Python API layers.
• Layered Architecture: Controllers (Api classes) → Services (CategoryService) → DAOs → Data Store.
• Repository Pattern: Business repositories in models/core/business.
• Client-side MVC: Angular controllers, directives, services, templates.
• Data Structure Optimization: In-memory Trie for search.
d. Key Technologies & Frameworks
• Frontend: AngularJS, Bootstrap, SCSS/SASS for styling.
• Backend: Flask, Flask-REST; config in Python modules.
• Database: MySQL (full-text), optional MongoDB connector.
• Build/Deploy: setup.py, Python packaging.
Detailed & Essential Capture
• Explicitly show all major modules (auth, book, cart, category, order, payment, shipment, wishlist).
• Angular module structure: controllers, services, directives, templates.
• How config modules supply parameters to DBConnection and services.
• Initialization flow: server.py → app.py loads config, registers blueprints for each Api.