Skip to content

Draft/brave volhard #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
salehah737 wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Draft/brave volhard #87

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
01aad04
Initial project setup with Django, React, Docker
salehah737 Apr 18, 2025
e22ab7d
Improved auth error handling
salehah737 Apr 18, 2025
cf6317d
Base repository: salehah737/groceries-project
salehah737 Apr 18, 2025
47b8011
Update README.md
salehah737 Apr 18, 2025
40734f4
update readme.md
salehah737 Apr 18, 2025
7fe7283
update
salehah737 Apr 18, 2025
050b169
git tag -d v0.2.0
salehah737 Apr 19, 2025
43b0838
git commit -m "initial commit: add groceries project structure
salehah737 Apr 19, 2025
280d1e1
tags: groceries-project
salehah737 Apr 19, 2025
bc5b612
Merge pull request #1 from salehah737/feature/search
salehah737 Apr 19, 2025
0603eb9
Merge pull request #2 from salehah737/mainn
salehah737 Apr 19, 2025
bbf5aae
Finalize changes for PR
salehah737 Apr 19, 2025
8703bc1
Fix view class names and filter configurations
salehah737 Apr 19, 2025
43fb24e
codesandbox
salehah737 Apr 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update readme.md
  • Loading branch information
@salehah737
salehah737 committed Apr 18, 2025
commit 40734f4e7fabfaa135b7b9b5f24ab4ccd4f578f8
100 changes: 66 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,40 +26,72 @@ A hybrid platform combining **brick-and-mortar franchise management** with **e-c

### **Directory Structure**
```bash
groceries-project/
├── backend/ # Python Core
│ ├── apps/
│ │ ├── franchises/ # Franchise location models, staff mgmt
│ │ ├── ecommerce/ # Product catalog, orders, payments
│ │ ├── inventory/ # Real-time stock tracking (per franchise)
│ │ └── users/ # Customer & franchise-owner auth
│ ├── utils/ # Pricing calculators, SMS/email services
│ ├── config/ # Settings, database connections
│ ├── requirements.txt
│ └── manage.py
│
├── frontend/ # E-Commerce UI
│ ├── public/
│ ├── src/
│ │ ├── components/ # Reusable UI (ProductCard, Cart, Navbar)
│ │ ├── pages/ # Next.js routes (Home, Checkout, Dashboard)
│ │ ├── store/ # Redux state (cart, user session)
│ │ └── services/ # API calls to backend
│ ├── package.json
│ └── Dockerfile
│
├── ops/ # DevOps
│ ├── docker-compose.yml # Multi-container setup
│ ├── nginx/ # Reverse proxy config
│ └── scripts/ # Deployment/backup scripts
│
├── docs/ # Project documentation
│ ├── API.md # Swagger/Postman specs
│ └── ERD.png # Database schema
│
├── .gitignore
├── README.md # Setup guide, project goals
└── .env # Environment variables
groceries-project/
├── backend/
│ ├── apps/
│ │ ├── ecommerce/
│ │ │ ├── models/
│ │ │ │ ├── order.py
│ │ │ │ ├── payment.py
│ │ │ │ └── cart.py
│ │ │ ├── serializers/
│ │ │ ├── views/
│ │ │ ├── urls.py
│ │ │ └── tests/
│ │ ├── franchises/
│ │ │ ├── models/
│ │ │ │ ├── franchise.py
│ │ │ │ └── staff.py
│ │ │ └── geo/
│ │ ├── inventory/
│ │ │ ├── models/
│ │ │ │ ├── product.py
│ │ │ │ ├── category.py
│ │ │ │ └── stock.py
│ │ │ └── management/
│ │ ├── users/
│ │ │ ├── models/
│ │ │ │ └── user.py
│ │ │ ├── auth/
│ │ │ └── profiles/
│ │ └── utils/
│ │ ├── notifications.py
│ │ ├── pricing.py
│ │ └── validators.py
│ ├── config/
│ │ ├── settings/
│ │ │ ├── base.py
│ │ │ ├── production.py
│ │ │ └── local.py
│ │ └── asgi.py
│ └── manage.py
├── frontend/
│ ├── src/
│ │ ├── components/
│ │ │ ├── cart/
│ │ │ ├── product/
│ │ │ └── franchise/
│ │ ├── pages/
│ │ │ ├── api/
│ │ │ ├── account/
│ │ │ └── checkout/
│ │ ├── store/
│ │ │ ├── cartSlice.ts
│ │ │ └── authSlice.ts
│ │ └── services/
│ │ ├── api.ts
│ │ ├── cart.ts
│ │ └── auth.ts
├── ops/
│ ├── docker/
│ │ ├── nginx/
│ │ └── postgres/
│ └── scripts/
├── docs/
│ ├── api/
│ └── architecture/
└── .github/
└── workflows/
```

---
Expand Down