wood-deck-demo v0.1.3

MINO - Wood Deck

Link dev 👉 ...

Technologies use

- NextJS App Router
- Typescript
- styled-components
- Redux Toolkit cho Stage management
- Thư viện UI Ant Design
- ThreeJS/React-three-fiber để vẽ các modal 3D
- KonvaJS/React-konva để vẽ các modal 2D

IDE setup

VSCode is highly preferred. Please ensure you have installed these extensions:

• Prettier
• stylelint
• eslint

Prerequisites

Cần cài đặt Node.js version >= 18.20.0

Setup

Clone repository từ gitlab

git clone + link repository

Dùng yarn để install các package cần thiết

yarn install

Sau đó start dev app với lệnh:

yarn dev

App sẽ được chạy ở http://localhost:3000 🚀

Project structure

src
|-- app => render các page
|-- components => common components
|-- config => các config thư viện nếu có
|-- constant => Khai báo constant variable
|-- features => các file tính năng và sẽ được import trực tiếp vào app
|-- helpers => util functions
|-- hooks => các custom hooks
|-- types => các khai báo type cho modal
|-- lib => các registry thư viện nếu có
|-- redux => state management
|-- theme => common style
...

Coding convention

1. Áp dụng rule của

   - TGL git flow : https://nextcloud.tgl-cloud.com/apps/files/?dir=/TGL_Solutions/08-QuyTrinhPhatTrienPhanMem&openfile=1419715
   - Tham khảo: [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow#:~:text=What%20is%20Gitflow%3F,lived%20branches%20and%20larger%20commits.).

2. Tách nhánh từ code mới nhất ở develop và đặt tên nhánh theo format

   feature/* //tính năng mới

   bugfix/* //fix bugs

3. Khi tạo MR nếu bị conflict phải pull code từ develop để fix, sử dụng lệnh sau:

   git pull origin develop

4. Quy tắc đặt tên các commit chuẩn commitlint:

   FORMAT: type: subject
   
   Type:
   build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
   ci: Changes to our CI configuration files and scripts (example scopes: Gitlab CI, Circle, BrowserStack, SauceLabs)
   chore: add something without touching production code (Eg: update npm dependencies)
   docs: Documentation only changes
   feat: A new feature
   fix: A bug fix
   perf: A code change that improves performance
   refactor: A code change that neither fixes a bug nor adds a feature
   revert: Reverts a previous commit
   style: Changes that do not affect the meaning of the code (Eg: adding white-space, formatting, missing semi-colons, etc)
   test: Adding missing tests or correcting existing tests
   
   Subject: là nội dung của commit

5. Quy tắc đặt tên type trong typescript:

      sử dụng Type (Không sử dụng interface)
      Quy tắc: T + Tên type (VD: TPerson)