Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/ecommerce-flask-stripe-deploy
Flask & Stripe - Mini eCommerce | AppSeed
https://github.com/app-generator/ecommerce-flask-stripe-deploy
deployment flask opensource stripe
Last synced: 2 days ago
JSON representation
Flask & Stripe - Mini eCommerce | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/ecommerce-flask-stripe-deploy
- Owner: app-generator
- License: other
- Created: 2022-11-17T15:28:42.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T18:44:57.000Z (about 2 years ago)
- Last Synced: 2025-02-05T20:56:51.894Z (10 days ago)
- Topics: deployment, flask, opensource, stripe
- Language: HTML
- Homepage: https://www.youtube.com/watch?v=iXjmWUNbTjA
- Size: 10.2 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask & Stripe](https://blog.appseed.us/flask-stripe-open-source-mini-ecommerce/) `Mini eCommerce`
Open-source mini `eCommerce` project that loads the products from `JSON` files saved in the `templates directory` (no database required) and uses a decent UI for page styling - Powered by **Flask**.
- 👉 [Flask & Stripe Presentation](https://www.youtube.com/watch?v=JDtigUqW_MM) - published on `YouTube`
- 👉 [Deploy Flask on Render](https://docs.appseed.us/deployment/render/flask) - `Step-by-step` tutorial
- ✅ Compatible with [LIVE Deployer](https://appseed.us/go-live/)
- [Deploy with Drag & Drop](https://www.youtube.com/watch?v=iXjmWUNbTjA) - `video material`
> Roadmap & Features
| Status | Item | info |
| --- | --- | --- |
| ✅ | **Flask** | For `backend logic` |
| ✅ | **Stripe** | `Payment processor` |
| ✅ | **[Soft UI Design](https://www.creative-tim.com/product/soft-ui-design-system?AFFILIATE=128200)** | (Free Version) by `Creative-Tim` |
| ✅ | **JSON** | `Products definition` - see [sample](./app/templates/products/product-air-zoom-pegasus.json) |
| ✅ | Automatic Products Discovery | Source DIR: [templates\products](./app/templates/products) |
| ✅ | **Dw Products from Stripe** | On going development via [Python Stripe Library](https://pypi.org/project/python-stripe/) |
| ✅ | **CI/CD** | Render Deployment Platform |
| ✅ | **Deployment** | `Docker` & Pages Compression |
## ✨ `Go LIVE` via [LIVE Deployer](https://appseed.us/go-live/)
> This video explains `how to deploy` the product LIVE using a `Drag & Drop` gesture.
https://user-images.githubusercontent.com/51070104/202530724-39364d09-17fe-4020-adc7-8003e2fabd49.mp4
## ✨ Start the app in `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/ecommerce-flask-stripe.git
$ cd ecommerce-flask-stripe
```
> 👉 **Step 2** - Add STRIPE secrets in `Dockerfile`
```Dokerfile
# Stripe Secrets
ENV STRIPE_SECRET_KEY
ENV STRIPE_PUBLISHABLE_KEY
```
> 👉 **Step 3** - Start the APP in `Docker`
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## ✨ Quick Start
> 👉 Rename `env.sample` to `.env`
- Edit `STRIPE_SECRET_KEY` - provided by Stripe Platform
- Edit `STRIPE_PUBLISHABLE_KEY` - provided by Stripe Platform
> 👉 Install dependencies
```bash
$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt
```
> 👉 Start the App
```bash
$ flask run
```
> 👉 Access the products and initiate a payment
**IMPORTANT**: Make sure your Stripe account is running in `TEST Mode` and Use Test CC provided by Stripe:
- **CC Number**: `4242 4242 4242 4242`
- Any data for the rest of the fields
## ✨ Create a new Product
- Go to `app/templates/products` directory
- Create a new `JSON` file with data:
- `name`: Used in product page & Cards
- `price`: Used for payment
- `currency`: Used for payment
- `info`: used in cards
- `short_description`: used in product page
- `full_description`: used in product page
- Create Media Files
- Go to `master/app/static/products`
- Create a directory using the same name as for `JSON` file
- Create `card.jpg`: 500x335px
- Create `cover.jpg`: 2100x1400px
- Start or refresh the app
- The new product should be listed in the `products/` page
- Product page is available at address:
- `http://localhost:5000/products//` where the SLUG is the name of the JSON file
> Sample product page generated for [Air ZOOM Pegasus](./app/templates/products/product-air-zoom-pegasus.json), assets loaded from [here](./app/static/products/product-air-zoom-pegasus)
## ✨ Codebase structure
The project has a simple structure, represented as bellow:
```bash
< PROJECT ROOT >
|
|-- app/__init__.py
|-- app/
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/
| | |
| | |-- includes/ # Page chunks, components
| | | |-- navigation.html # Top bar
| | | |-- sidebar.html # Left sidebar
| | | |-- scripts.html # JS scripts common to all pages
| | | |-- footer.html # The common footer
| | |
| | |-- layouts/ # App Layouts (the master pages)
| | | |-- base.html # Used by common pages like index, UI
| | | |-- base-fullscreen.html # Used by auth pages (login, register)
| | |
| | |-- products/ # Define your products here
| | | |-- nike-goalkeeper-match.json # Sample product
|
|-- requirements.txt
|
|-- run.py
|
|-- ************************************************************************
```
## ✨ Credits & Links
- [Flask Framework](https://www.palletsprojects.com/p/flask/) - The official website
- [Stripe Dev Tools](https://stripe.com/docs/development) - official docs
---
[Flask Stripe Sample](https://blog.appseed.us/flask-stripe-open-source-mini-ecommerce/) - Free sample provided by [AppSeed](https://appseed.us).