Skip to content
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.

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

Write code convention FE #1

Open
minhhy2801 opened this issue Mar 24, 2024 · 1 comment
Open

Write code convention FE #1

minhhy2801 opened this issue Mar 24, 2024 · 1 comment
Assignees

Comments

@minhhy2801
Copy link

Please help add your code convention of FE and BE side
Here is an example in FE for you to have a look:

@minhhy2801 minhhy2801 changed the title Write code convention FE, BE Write code convention FE Mar 24, 2024
@ghost ghost assigned ghost and unassigned ghost Mar 26, 2024
@B34R-e B34R-e self-assigned this Mar 26, 2024
@bentran1vn bentran1vn self-assigned this Mar 26, 2024
@bentran1vn
Copy link
Collaborator

[ UNIQLO ] FRONTEND - CODING CONVENTIONS

CODING RULE

1. Quy ước đặt tên:

  • Wrapper Folder: Lower-Case
    • Function Folder: Title-Case
    • File:
      • Component: Title-Case
      • Not-Component: lower-case

2. Khai báo biến:

  • Khai báo biến bằng const.

FOLDER DESCRIPTION

👉 UNIQLO Project
|
└───dist
└───node_modules
└───public
|   └───images
│       └───mainLayout
│           │ image1.png
│           │ image2.png
│
│       └───leaderLayout
│           │ image1.png
│           │ image2.png
└─── src
|    └───apis
|        └───auth.api.ts
|    └───components
|        └───Button
|            |  Button.tsx
|            |  index.ts
|
|        └───Footer
|    └───constant
|        |  httpStatus.ts
|        |  path.ts
|
|    └───context
|        |  app.context.tsx
|
|    └───layouts
|        └───MainLayout
|            |  MainLayout.tsx
|            |  index.ts
|
|        └───HeaderLayout
|
|    └───pages
|        └───Login
|            |  Login.tsx
|            |  index.ts
|
|        └───ProductList
|    └───types
|        |  auth.type.ts
|        |  user.type.ts
|
|    └───utils
|        │  auth.ts
|        │  http.ts
|
│    .editorconfig
│    .eslintignore
│    .eslintrc.cjs
│    .prettierignore
│    .prettierrc
│    package.json
│    vercel.json
│    .gitignore
│    README.md

1.dist:

  • Thư mục chứa các file build.

2. src:

  • Thư mục chứa mã nguồn.
    vd: constants, controller....

3.src/apis:

  • Chứa các file tương tác với API.

4.src/components:

  • Chứa Các Component Folders.

5.src/components/component:

  • Chứa Component.
  • Chứa các Component có thể tái sử dụng ở nhiều nơi.
    -> Như Button có thể xài ở nhiều pages Login hoặc Register vì đăng nhập hay đăng kí thì đều phải có nút bấm

6.src/constants:

  • Chứa các file chứa các hằng số, chứa những thứ xài chung.

7.src/context:

  • Chứa file quản lý các Global State

8.src/layouts:

  • Chứa Các Layout Component Folders.

9.src/layouts/layout:

  • Chứa Các Layout Component.
  • Chứa toàn bộ giao diện của 1 trang web. Ví dụ trang Đăng Nhập thì có Header, Login, Footer. Nếu biến Component Login thành Children thì ra có thể tái sử dụng Header, Footer cho phần Register

10.src/pages:

  • Chứa Các Page Component Folders.
  • Nơi các Component mà bên trong xử lý logic
    -> Ví dụ Component Login. Bên trong sẽ gọi API

9.src/types:

  • Chứa các types, interface custom.

10.src/utils:

  • Chứa các file chứa các hàm tiện ích...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants