Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hardmax71/modular-store-flask
Web-store made with Python/Flask/SQLite
https://github.com/hardmax71/modular-store-flask
bootstrap4 chatra e-commerce flask oauth python sqlalchemy sqlite stripe webshop
Last synced: about 1 month ago
JSON representation
Web-store made with Python/Flask/SQLite
- Host: GitHub
- URL: https://github.com/hardmax71/modular-store-flask
- Owner: HardMax71
- License: mit
- Created: 2024-03-04T22:40:49.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-31T21:28:16.000Z (3 months ago)
- Last Synced: 2024-09-26T18:25:33.840Z (about 1 month ago)
- Topics: bootstrap4, chatra, e-commerce, flask, oauth, python, sqlalchemy, sqlite, stripe, webshop
- Language: Python
- Homepage: https://monkfish-app-mbn3z.ondigitalocean.app/
- Size: 5.22 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Modular Store
A comprehensive, feature-rich e-commerce platform built with Flask
[](https://codecov.io/gh/HardMax71/modular-store-flask)
[](https://wave.webaim.org/report#/https://monkfish-app-mbn3z.ondigitalocean.app)
[](http://mypy-lang.org/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/HardMax71/modular-store-flask/commits/main)
[](https://monkfish-app-mbn3z.ondigitalocean.app/)
[Demo](https://monkfish-app-mbn3z.ondigitalocean.app/) | [Report Bug](https://github.com/HardMax71/modular-store-flask/issues) | [Request Feature](https://github.com/HardMax71/modular-store-flask/issues)
> [!IMPORTANT]
> The names, trademarks, service marks, logos, and other data displayed on the demo website and in this repository are
> the intellectual property of their respective owners. The utilization of these names, trademarks, service marks,
> logos,
> or other proprietary materials does not indicate any affiliation with, endorsement by, or sponsorship by the
> respective
> trademark owners. All references to such proprietary materials are provided solely for illustrative purposes and do
> not
> imply any claim of ownership or confer any legal rights. The repository owner expressly disclaims any legal liability
> or
> responsibility for any misuse, misinterpretation, or misrepresentation of these proprietary materials.
## About The Project
Modular Store Flask is a state-of-the-art e-commerce solution designed to provide a flexible and scalable platform for
online stores. Built with Flask, it offers a wide range of features to enhance both user experience and store
management.
### Key Features
- 🛒 **Robust Shopping Cart System**: Seamless shopping experience with real-time updates.
- 🔍 **Advanced Product Search & Filtering**: Help customers find exactly what they're looking for.
- 👤 **User Authentication & Profiles**: Secure login and personalized user experiences.
- 💳 **Multiple Payment Options**: Support for various payment methods to accommodate all customers.
- 📊 **Admin Dashboard**: Comprehensive tools for managing products, orders, and customers.
- 🌐 **Multi-language Support**: Reach a global audience with localized content.
- 📱 **Responsive Design**: Perfect shopping experience across all devices.
- 🔒 **Security Features**: Implement best practices to keep your store and customers safe.
Getting Started
### Prerequisites
- Python 3.8+
- pip
- Virtual environment (recommended)
### Installation
1. Clone the repository:
```
git clone https://github.com/HardMax71/modular-store-flask.git
cd modular-store-flask
```
2. Create and activate a virtual environment:
```
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. Install the required packages:
```
pip install -r requirements.txt
```
4. Run the application:
```
python modular_store_backend/app.py
```
Visit `http://localhost:5000` in your browser to see the application running.
Current state of things
| Feature Category | Feature Idea | Status |
|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| Product Catalog | * Display products with images, prices, and other relevant information
* Implement product categories and subcategories for better organization
* Allow users to search for products based on keywords, categories, or tags
* Implement product filtering and sorting options
* Display related products or product recommendations | :heavy_check_mark: |
| Product Details | * Create a detailed product page with all relevant information
* Display product variants (e.g., size, color) and allow users to select them
* Show product reviews and ratings from other users
* Implement a product rating system for users to rate products
* Allow users to add products to their wishlist | :heavy_check_mark: |
| Shopping Cart | * Allow users to add products to their shopping cart
* Display the total price and number of items in the cart
* Provide options to update quantities or remove items from the cart
* Implement a mini-cart or quick view of the cart contents
* Allow users to apply discount codes or promotional offers | :heavy_check_mark: |
| Checkout Process | * Implement a multi-step checkout process (e.g., shipping address, billing information, order summary)
* Allow users to select a shipping address or add a new one
* Provide options for different shipping methods and calculate shipping costs
* Integrate with a payment gateway for secure online payments
* Display order confirmation and send email receipts | :heavy_check_mark: |
| Order Management | * Implement an order tracking system for users to view their order status
* Allow users to view their order history and details
* Provide options for users to cancel or modify orders (if applicable)
* Send email notifications for order updates and shipping information | :heavy_check_mark: |
| User Reviews and Ratings | * Allow users to write reviews and rate products they have purchased
* Display user reviews and ratings on product pages
* Implement a moderation system for reviewing and approving user-generated content
* Provide options for users to report inappropriate reviews or ratings | :heavy_check_mark: |
| Wishlist Functionality | * Allow users to add products to their wishlist
* Provide options to manage wishlist items (remove, add to cart)
* Send email notifications or reminders for wishlist items on sale or back in stock | :heavy_check_mark: |
| Discounts and Promotions | * Implement a discount code system for promotional offers
* Apply discounts automatically during the checkout process
* Display promotional banners or popups for ongoing sales or special offers
* Send email notifications for personalized discounts or limited-time offers | :heavy_check_mark: |
| Notifications and Alerts | * Implement a notification system for users (e.g., order updates, product back in stock)
* Allow users to manage their notification preferences
* Send email alerts for important events or updates | :heavy_check_mark: |
| Product Inventory Management | * Track product inventory levels and update them in real-time
* Implement low stock alerts or notifications for admin users
* Provide options to mark products as out of stock or discontinued | :heavy_check_mark: |
| Analytics and Reporting | * Implement analytics tracking for user behavior and sales data
* Generate reports for sales, revenue, and product performance
* Provide insights and metrics for marketing and business decisions | :heavy_check_mark: |
| Search and Autocomplete | * Implement a search functionality for users to find products easily
* Provide autocomplete suggestions based on user input
* Optimize search results based on relevance and popularity | :heavy_check_mark: |
| Product Comparison | * Allow users to compare multiple products side by side
* Display key features, specifications, and prices for easy comparison
* Provide options to add compared products to the cart or wishlist | :heavy_check_mark: |
| Social Sharing and Integration | * Implement social sharing buttons for products and pages
* Allow users to login or register using their social media accounts
* Integrate with social media platforms for product promotion and user engagement | :heavy_check_mark: |
| Customer Support and Live Chat | * Implement a customer support ticketing system
* Provide live chat functionality for real-time assistance
* Offer self-service options like FAQs or knowledge base articles | :heavy_check_mark:
Live chat - via [Chatra](https://chatra.com/) |
| Mobile Optimization and Design | * Ensure the web store is fully responsive and mobile-friendly
* Optimize images and assets for faster loading on mobile devices
* Implement mobile-specific features like swipe gestures or mobile payments | :heavy_check_mark: |
| Internationalization | * Support multiple languages and currencies for a global audience
* Implement geolocation to detect user's location and adapt the store accordingly
* Provide options for users to switch languages or currencies | :heavy_check_mark:
\[2 langs supported, using user settings
to detect best possible lang\] |
| Personalization and Recs | * Implement personalized product recommendations based on user behavior
* Display recently viewed or related products for each user
* Send personalized email campaigns or newsletters based on user preferences | :heavy_check_mark: |
| Security and Privacy | * Implement secure user authentication and authorization
* Protect user data and transactions with encryption and secure protocols
* Comply with relevant privacy regulations (e.g., GDPR, CCPA) | :heavy_check_mark: |
| Performance Optimization | * Optimize website speed and performance for better user experience
* Implement caching mechanisms for faster page loading
* Minimize the use of third-party scripts or plugins that may slow down the site
* Regularly monitor and optimize database queries for improved performance | :heavy_check_mark: |
| Accessibility | * Ensure the web store is accessible to users with disabilities
* Follow web accessibility guidelines (e.g., WCAG) for inclusive design
* Provide alternative text for images and proper labeling for form elements
* Test the store for compatibility with assistive technologies | :question:
Checker for WCAG compliance added, to do - be compliant |
| Testing and Quality Assurance | * Implement a comprehensive testing strategy for the web store
* Conduct functional testing, usability testing, and performance testing
* Perform cross-browser and cross-device testing for compatibility
* Establish a quality assurance process to identify and fix bugs or issues | :heavy_check_mark:
Unit & integration testing - done, QA via Github actions - done, Browser testing - not planned for now |
| Backup and Disaster Recovery | * Implement regular data backups to prevent data loss
* Develop a disaster recovery plan for unexpected events or system failures | :heavy_check_mark: |
## Project Structure
The project follows a modular structure, with each module typically containing:
- `__init__.py`: Initializes the module and registers routes and views (in a blueprint).
- `views.py`: Contains the route definitions and view functions.
- `utils.py`: Contains utility functions specific to the module.
```
modular-store-flask/
│
├── modular_store_backend/ # Backend package
│ ├── forms/ # Form definitions
│ ├── instance/ # Folder for database instance
│ ├── modules/ # Application modules
│ ├── tests/ # Backend tests
│ ├── app.py # Application factory
│ └── config.yaml # Configuration settings
│
├── modular_store_frontend/ # Frontend package
│ ├── static/ # Static files
│ │ ├── css/ # CSS files
│ │ ├── img/ # Image files
│ │ ├── js/ # JavaScript files
│ │ └── robots.txt # Robots file for search engines
│ │
│ └── templates/ # HTML templates
│ ├── admin/ # Admin-related templates
│ ├── auth/ # Authentication templates
│ ├── cart/ # Shopping cart templates
│ ├── tickets/ # Support ticket templates
│ ├── website_parts/ # Reusable website components
│ ├── add_address.html
│ ├── base.html
│ ├── ...
│ └── recommendations.html
│
├── translations/ # Internationalization files
├── ...
└── README.md # Project documentation
```
This structure represents the main components of the Modular Store Flask project:
- `modular_store_backend/`: The main package containing the application code.
- `modular_store_backend/app.py`: The application factory.
- `modular_store_backend/config.yaml`: Contains configuration settings for different environments.
- `modular_store_backend/modules/`: Houses the different functional modules of the application.
- `modular_store_backend/static/`: Contains all static files like CSS, JavaScript, and images.
- `modular_store_backend/templates/`: Holds all the HTML templates used in the application.
- `modular_store_backend/translations/`: Contains files for internationalization support.
- `tests/`: Contains all the unit and integration tests for the project.
Each module in the `modules/` directory typically contains its own views, forms, and utility functions,
promoting a modular and maintainable code structure.
## Database Schema
Simplified database schema for the application:
Click to view full database schema
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.