https://github.com/pankaj085/lotuslynx
LotusLynx is a modern e-commerce backend built with FastAPI, SQLAlchemy, and Pydantic. It features robust user authentication, JWT-based authorization, product and order management, and a clean, modular codebase.
https://github.com/pankaj085/lotuslynx
ecommerce-application fastapi postgresql python sqlalchemy
Last synced: about 2 months ago
JSON representation
LotusLynx is a modern e-commerce backend built with FastAPI, SQLAlchemy, and Pydantic. It features robust user authentication, JWT-based authorization, product and order management, and a clean, modular codebase.
- Host: GitHub
- URL: https://github.com/pankaj085/lotuslynx
- Owner: pankaj085
- License: mit
- Created: 2025-05-18T10:17:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-03T09:42:57.000Z (about 1 year ago)
- Last Synced: 2025-07-03T09:41:39.758Z (12 months ago)
- Topics: ecommerce-application, fastapi, postgresql, python, sqlalchemy
- Language: Python
- Homepage:
- Size: 104 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LotusLynx E-commerce Platform
> 🚧 **Project Status: Under Active Development**
## Tech Stack
## Project Overview
A backend-focused e-commerce platform built with FastAPI, emphasizing robust API development, secure authentication, and modern backend practices. While the project includes basic templates for administrative interfaces, the primary focus is on building a solid, production-ready backend API.
### Key Focus Areas
- **Backend Development**: Comprehensive FastAPI implementation
- **API Design**: RESTful API with detailed documentation
- **Security**: JWT authentication, role-based access control
- **Payment Integration**: Stripe payment processing
- **File Management**: Cloudinary integration for image storage
- **Database**: PostgreSQL with SQLAlchemy ORM
- **Testing**: Comprehensive test coverage with pytest
### Frontend Note
The project uses simple Jinja2 templates for administrative interfaces. The primary goal is to create a robust API that can be consumed by any frontend technology in the future.
## Current Progress
- ✅ Backend API setup with FastAPI
- ✅ Database models and schemas
- ✅ User authentication with JWT (access/refresh tokens)
- ✅ Product management with image upload
- ✅ Stripe payment integration
- ✅ Role-based access control
- 🔄 Cart and Order system (In Progress)
- ⏳ Frontend development (Planned)
## Technology Stack
### Backend
- **FastAPI**: Modern Python web framework
- **SQLAlchemy**: SQL toolkit and ORM
- **Pydantic**: Data validation
- **PostgreSQL**: Primary database
- **JWT**: Authentication tokens
- **Alembic**: Database migrations
### External Services
- **Stripe**: Payment processing
- **Cloudinary**: Image storage and optimization
### Development Tools
- **Python 3.10+**
- **Poetry/pip**: Dependency management
- **pytest**: Testing framework
- **uvicorn**: ASGI server
## Project Structure
```
lotuslynx/
│
├── .env # Environment variables
├── .gitignore # Standard Python + frontend ignores
├── requirements.txt # With dev dependencies separated
├── Dockerfile # Multi-stage build
├── docker-compose.yml # App + DB + Redis + Frontend
├── alembic.ini # Migration config
│
├── backend/
│ ├── __init__.py # Package marker
│ ├── main.py # FastAPI app (lifespan setup)
│ ├── database.py # SQLAlchemy async/sync setup
│ ├── utils.py # Miscellaneous helpers
│ │
│ ├── core/ # Critical utilities
│ │ ├── __init__.py # Exports config, auth
│ │ ├── auth.py # JWT logic (access/refresh)
│ │ ├── config.py # Pydantic settings
│ │ └── security.py # OAuth2 schemes
│ │
│ ├── dependencies/ # Reusable FastAPI deps
│ │ ├── __init__.py # Clean exports
│ │ ├── auth.py # get_current_user
│ │ ├── roles.py # require_admin/require_editor
│ │ ├── payments.py # stripe_payment
│ │ └── database.py # get_db (session)
│ │
│ ├── models/ # SQLAlchemy ORM
│ │ ├── __init__.py # Exposes models
│ │ ├── user.py # User, roles
│ │ ├── product.py # Product, categories
│ │ ├── cart.py # Cart, CartItem
│ │ └── order.py # Order, OrderItem
│ │
│ ├── schemas/ # Pydantic models
│ │ ├── __init__.py # Exposes schemas
│ │ ├── user.py # UserCreate, UserResponse
│ │ ├── product.py # Product CRUD schemas
│ │ ├── cart.py # Cart operations
│ │ └── order.py # Order workflows
│ │
│ ├── routers/ # API endpoints
│ │ ├── __init__.py # Router aggregation
│ │ ├── auth_router.py # /auth/*
│ │ ├── products_router.py # /products/* (with Cloudinary)
│ │ ├── cart_router.py # /cart/*
│ │ └── orders_router.py # /orders/*
│ │
│ ├── services/ # External integrations
│ │ ├── __init__.py
│ │ ├── payment.py # Stripe/PayPal
│ │ ├── email.py # SMTP templates
│ │ └── cloudinary.py # Image upload helpers
│ │
│ └── tests/ # Pytest
│ ├── __init__.py
│ ├── conftest.py # Fixtures
│ ├── test_auth.py
│ └── test_products.py
│
├── frontend/ # Static files
│ ├── static/ # Built assets (Vite/Webpack)
│ │ ├── css/
│ │ ├── js/
│ │ └── img/
│ │
│ └── templates/ # Jinja2 templates
│ ├── base.html # Layout
│ ├── auth/
│ │ ├── login.html
│ │ └── register.html
│ └── admin/
│ ├── dashboard.html
│ └── products.html
│
├── alembic/ # Migrations
│ ├── versions/
│ ├── env.py
│ └── script.py.mako
│
└── scripts/ # Deployment/DB
├── seed_db.py # Test data
└── backup_db.sh # PostgreSQL dumps
```
## Features
### Implemented
- JWT Authentication with refresh tokens
- Role-based access control (Admin/Editor/User)
- Product management with image upload
- Secure payment processing with Stripe
- Cloudinary integration for image storage
### Planned
- Shopping cart functionality
- Order management
- User profiles
- Admin dashboard
- Email notifications
- React frontend
- Docker containerization
## Getting Started
1. Clone the repository:
```bash
git clone https://github.com/yourusername/lotuslynx.git
cd lotuslynx
```
2. Set up environment:
```bash
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
3. Configure environment variables:
```bash
cp .env.example .env
# Edit .env with your credentials
```
4. Run development server:
```bash
uvicorn backend.main:app --reload
```
## Development Roadmap
1. **Phase 1** (Current)
- Complete core backend functionality
- Implement comprehensive testing
- Document API endpoints
2. **Phase 2**
- Develop React frontend
- Add shopping cart
- Implement order system
3. **Phase 3**
- Add admin dashboard
- Email integration
- Performance optimization
4. **Phase 4**
- Docker containerization
- CI/CD setup
- Production deployment
## API Documentation
Once the server is running, visit:
- Swagger UI: `http://localhost:8000/docs`
- ReDoc: `http://localhost:8000/redoc`
## Environment Variables
Required environment variables in your `.env` file:
```ini
# Database
DATABASE_URL=postgresql://user:password@localhost/dbname
# Authentication
SECRET_KEY=your-secret-key
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRES_MINUTES=30
REFRESH_TOKEN_EXPIRES_DAYS=7
# Cloudinary
CLOUDINARY_CLOUD_NAME=your-cloud-name
CLOUDINARY_API_KEY=your-api-key
CLOUDINARY_API_SECRET=your-api-secret
# Stripe
STRIPE_SECRET_KEY=your-stripe-secret-key
STRIPE_WEBHOOK_SECRET=your-webhook-secret
STRIPE_CURRENCY=usd
```
## API Endpoints
### Auth Routes
- `POST /auth/register` - Register new user
- `POST /auth/login` - Login user
- `POST /auth/refresh` - Refresh access token
### Product Routes
- `GET /products` - List all products
- `POST /products` - Create product (Admin only)
- `GET /products/{id}` - Get product details
- `PUT /products/{id}` - Update product (Admin only)
- `DELETE /products/{id}` - Delete product (Admin only)
### Additional routes documentation in progress...
## Development Guidelines
- Follow PEP 8 style guide
- Write docstrings for all functions/classes
- Include type hints
- Write tests for new features
- Keep the codebase modular and clean
## Support & Contact
For support, mail [pankaj085k@gmail.com](mailto:pankaj085k@gmail.com "Send an E-mail") or create an issue in the repository.
## Acknowledgments
- FastAPI Documentation
- SQLAlchemy Documentation
- Stripe API Documentation
- Cloudinary Documentation
## Contributing
Currently, this is a personal project in development. Contributions might be welcome in the future.
## License
This project is licensed under the [MIT License](LICENSE) - see the [LICENSE](LICENSE) file for details.
## Author
Pankaj Kushwaha - [GitHub](https://github.com/pankaj085 "Follow me on GitHub") | [LinkedIn](https://www.linkedin.com/in/py--dev/ "Follow me on LinkedIn")