Project FoodSave

Project FoodSave là webapp để giúp người dùng giảm thiểu tối đa lượng thức ăn bị thừa (do nấu quá nhiều), vì thức ăn thừa bị thải ra môi trường cũng là một trong những nguyên nhân gây ra ô nhiễm môi trường.

Project này được chia làm 2 phần: Frontend và Backend (as usual).

Frontend

Frontend được viết bằng React + Typescript, và được bundle lại thành web bởi Vite. GUI được thiết kế dựa trên mẫu thiết kế Material UI (design của Google).

Khi compile phần frontend, máy compile phải cài các dependency sau:

• Node.js (>=18), đi kèm đó là npm

Hướng dẫn sử dụng:

cd frontend

# Cài đặt các JS dependency từ npm
npm install

# Nếu muốn chạy server nội bộ (development server), sử dụng lệnh sau:
npm run dev

# Nếu muốn xuất ra static file để đưa lên web server (vd: GitHub Pages), sử dụng lệnh sau:
npm run build
# File khi xuất ra sẽ được đặt trong /dist

Backend

Backend được viết bằng Typescript, và sẽ giao tiếp với Frontend thông qua REST API (sử dụng tRPC, bằng cách này sẽ giúp cho kiểu dữ liệu được đảm bảo)

Khi chạy phần backend, cần phải có:

• MongoDB server
• Node.js (>=18)

Hướng dẫn sử dụng (nhớ cấu hình file .env bằng cách copy .env.example sau đó điền):

cd backend

# Cài đặt các JS dependency từ npm
npm install

# Nếu muốn chạy server, sử dụng lệnh sau:
npm start

Copyright

Project này được phát hành với giấy phép MIT, nghĩa là bạn có quyền làm bất cứ điều gì đối với source code được cung cấp này, tuy nhiên tác giả SẼ KHÔNG CHỊU TRÁCH NHIỆM VỚI BẤT CỨ ĐIỀU GÌ XẢY RA KHI BẠN DÙNG PROJECT NÀY. Chi tiết xin vui lòng đọc LICENSE (bằng tiếng Anh).

2022 (C) C3CIA (C3CBot x Xavia) / Team 17 @ Game UIT Hackathon 2022