BE-PERFUME-SHOP

Clone Project

git clone https://github.com/UTH-BrotherHood/BE-PERFUME-SHOP.git

Cài đặt các gói phụ thuộc (dependencies) của dự án

npm i

Diagram

[Database Diagram]

Hệ Quản Trị Cơ Sở Dữ Liệu

PostgreSQL

Ngôn Ngữ

Express, TypeScript

Quy Tắc

• Code theo một kiểu thống nhất:
  • Tên file viết thường, tên biến và body request kiểu Snake Case (ví dụ: this_is_snake_case, THIS_IS_SCREAMING_SNAKE_CASE).
• Sau khi code xong, hãy push lên nhánh temp. Sau đó, nếu tất thành viên trong nhóm thống nhất, thì mới merge vô nhánh main.
• Khi tạo một routes mới thì note lại cho anh em frontend dễ làm hơn , ví dụ như đoạn code dưới :

/*
Description: This route is used to logout
Path: /logout
Method: POST
Headers: { Authorization : Bearer <accessToken> }
Body: { refresh_token : string}
*/
usersRouters.post('/logout', accessTokenValidation, refreshTokenValidation, wrapRequestHandler(logoutController))

Docs

PostgreSQL

• sử dụng postgresql , mọi người ai chưa tải thì xem hướng dẫn Tại đây ( nhớ note lại mật khẩu nha ae , quên là hết cíu )
• tạo database đặt tên là PERFUME-SHOP
• anh em tự vô file .env để chỉnh lại mật khẩu của anh em nha ở phần DB_PASSWORD
• sau đó vô source ctrl + s file index sẽ tự tạo bảng cho anh em

Postman

• mở postman import file src/models/postman/PERFUME-SHOP.postman_collection.json vào phần Collections , và import file src/models/postman/PERFUME-SHOP-ENV.postman_environment.json vào phần Environments
• sau đó ở góc trên bên phải ứng dụng postman anh em chọn PERFUME-SHOP-ENV như hình bên dưới

• sau đó sử dụng như bình thường , khi có thay đổi tui sẽ commit update lên github cho ae đỡ mất thời gian
• nếu bị trục trặc thì mọi người vô file routes cũng có note hết phần method , header, requestbody, ... sẳn , rồi mọi người tự làm trong postman cũng được