Skip to content

Revise README for clarity and additional details #26

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

Closed
tphuocsieunhan wants to merge 1 commit into from
Closed

Revise README for clarity and additional details #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 44 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,39 @@
# Hangry
# HANGRY - DANHPHUOCxFOODFAST

Hangry là hệ sinh thái đặt đồ ăn đa kênh xây trên MERN + Expo. Người dùng có thể duyệt menu, thêm giỏ, thanh toán (Stripe/COD) và theo dõi đơn; đội vận hành có portal để quản lý món, đơn và người dùng.
Hangry là hệ sinh thái đặt đồ ăn đa kênh (MERN + Expo). Người dùng duyệt menu, thêm giỏ, thanh toán (Stripe/COD), mã khuyến mãi, theo dõi đơn - đơn được giao theo phương thức truyền thống bằng Tài Xế, nhưng kết hợp phương thức mới bằng Drone; đội vận hành có portal quản lý món/đơn, và console quản trị người dùng.

## Tech Stack
MongoDB · Express.js · React (Vite) · Node.js · React Native (Expo) · Stripe · Cloudinary/Uploads · JWT

## Mục Lục
## Mục lục
- [Live Link](#live-link)
- [Tính Năng](#tính-năng)
- [Tech Stack](#tech-stack)
- [Cài Đặt](#cài-đặt)
- [Sử Dụng](#sử-dụng)
- [API Chính](#api-chính)
- [Tính năng](#tính-năng)
- [Kiến trúc & Tech Stack](#kiến-trúc--tech-stack)
- [Cài đặt](#cài-đặt)
- [Biến môi trường](#biến-môi-trường)
- [Chạy dự án](#chạy-dự-án)
- [CI](#ci)
- [Quy tắc nhánh/PR](#quy-tắc-nhánhpr)
- [API chính (tóm tắt)](#api-chính-tóm-tắt)
- [Đóng Góp](#đóng-góp)
- [License](#license)

## Live Link
## Live Link (Demo)
- Web khách hàng: https://hangry-frontend.onrender.com
- Backend mẫu: https://hangry-backend.onrender.com

## Tính Năng
## Tính năng
- Đăng ký/đăng nhập JWT, phân quyền user/admin.
- Duyệt danh mục, thêm/giảm giỏ, thanh toán Stripe hoặc COD.
- Portal admin thêm món (upload ảnh), duyệt menu, cập nhật trạng thái đơn.
- Console quản lý người dùng (lọc, khóa/mở, đổi role, xóa).
- Ứng dụng di động Expo tabs: Home, Cart, Orders, Profile.
- Duyệt danh mục, đặt món từ nhiều nhà hàng, thêm/giảm giỏ, áp mã khuyến mãi, thanh toán Stripe hoặc COD, theo dõi trạng thái đơn.
- Portal admin: thêm món (upload ảnh), duyệt menu, cập nhật trạng thái đơn.
- User console (users-admin): quản lý người dùng (lọc, khóa/mở, đổi role, xóa).
- Ứng dụng di động Expo (tabs: Home, Cart, Orders, Profile).

## Kiến trúc & Tech Stack
- Backend: Node.js/Express, MongoDB, JWT, Stripe.
- Frontend web: React + Vite.
- Admin portal: React + Vite.
- Users-admin console: React + Vite.
- Mobile: React Native (Expo).
- CI: GitHub Actions (`.github/workflows/ci.yml`).

## Cài Đặt
## Cài đặt
```bash
git clone https://github.com/TNTDanh/Software_Hangry.git
cd Software_Hangry
Expand All @@ -39,9 +46,9 @@ cd ../mobile && npm install
```

### Biến môi trường
- `backend/.env`: `PORT`, `MONGO_URI`, `JWT_SECRET`, `CLIENT_URL`, `FRONTEND_URL`, `STRIPE_SECRET_KEY`, các khóa Cloudinary (nếu dùng).
- `frontend/.env`, `admin/.env`, `users-admin/.env`: `VITE_API_URL=http://localhost:4000`.
- `mobile/src/api/client.ts` & `mobile/src/until/image.ts`: cập nhật `API_URL` phù hợp (VD: `http://10.0.2.2:4000` trên Android emulator).
- Backend: `backend/.env`: `PORT`, `MONGO_URI`, `JWT_SECRET`, `CLIENT_URL`, `FRONTEND_URL`, `STRIPE_SECRET_KEY`, và `khóa Cloudinary/Uploads` (nếu dùng).
- Frontend: `frontend/.env`, `admin/.env`, `users-admin/.env`: `VITE_API_URL=http://localhost:4000`.
- Mobile: cập nhật `mobile/src/api/client.ts` & `mobile/src/until/image.ts` với `API_URL` phù hợp (VD: `http://10.0.2.2:4000` trên Android emulator).

### Chạy dự án
| Module | Lệnh |
Expand All @@ -52,17 +59,22 @@ cd ../mobile && npm install
| User console | `cd users-admin && npm run dev`|
| Mobile (Expo) | `cd mobile && npx expo start` |

## Sử Dụng
1. Mở web/app → đăng ký/đăng nhập.
2. Duyệt menu, lọc danh mục, thêm món vào giỏ.
3. Đặt đơn (Stripe redirect hoặc COD) và theo dõi trạng thái.
4. Admin dùng portal để thêm món, chỉnh đơn; console để quản lý người dùng.
### CI
- Workflow: `.github/workflows/ci.yml`
- Trigger: `push/PR lên dev và main.`
- Bước: checkout → setup Node 20 → install & build frontend/admin/users-admin, install + lint mobile, install backend.

### Quy tắc nhánh/PR
- Nhánh chính: main (default). Nhánh phát triển: dev.
- Branch protection: yêu cầu PR + CI pass, chặn force-push (áp dụng cho main và dev).
- Merge: dùng merge commit để giữ lịch sử theo module; có thể squash nếu muốn gọn.

## API Chính
- **User:** `POST /api/user/register`, `POST /api/user/login`, `GET /api/user/list`, `POST /api/user/update`, `POST /api/user/remove`.
- **Food:** `POST /api/food/add`, `GET /api/food/list`, `POST /api/food/remove`.
- **Cart:** `POST /api/cart/add`, `/remove`, `/get`.
- **Order:** `POST /api/order/place`, `/place-cod`, `/verify`, `/userorders`, `GET /api/order/list`, `POST /api/order/status`.
### API chính (tóm tắt)
- **User:** POST /api/user/register, POST /api/user/login, GET /api/user/list, POST /api/user/update, POST /api/user/remove
- **Food:** POST /api/food/add, GET /api/food/list, POST /api/food/remove
- **Cart:** POST /api/cart/add, /remove, /get
- **Order:** POST /api/order/place, /place-cod, /verify, /userorders, GET /api/order/list, POST /api/order/status
- (Các API mở rộng khác như city/promotion/restaurant/review/support… xem code trong backend/routes/*)

## Đóng Góp
1. Fork repo & tạo nhánh `feat/<ten>`.
Expand Down
Loading