🏃 Developers

🍟 heeskim | 🦖 jonkim | 🐚 yyoo | 🐹 hjeong | 🚬 junhyuki

📖 History

• 23/05/05 - 개발환경 dockerize
• 23/08/17 - 프로젝트 평가 완료
• 23/09/11 - 리팩터링 시작 및 리드미 작성

👩‍💻 Tech Stack

Common

FrontEnd

BackEnd

🚧 Structure

./
├── frontend/
│   ├── public/       # index
│   │   ├── avatar/   # avatar image files
│   │   ├── channel/  # channel icon files
│   │   ├── font/     # font files
│   │   ├── ranking/  # ranking page image files
│   │   └── img/      # image files
│   └── src/
│       ├── channel/  # channel view & logic
│       ├── chat/     # chat view & logic
│       ├── custom/   # custom view & logic
│       ├── dm/       # dm view & logic
│       ├── game/     # game view & logic
│       ├── login/    # login view & logic
│       ├── menu/     # menu view & logic
│       ├── ranking/  # ranking view & logic
│       └── sidebar/  # sidebar view & logic
└── backend/
    ├── prisma/       # database
    └── src/
        ├── auth/     # authentication for login
        ├── channel/  # socket based chat
        ├── config/   # environment variables
        ├── game/     # control game queue & game render
        ├── member/   # manage members
        ├── prisma/   # prisma ORM
        ├── socketIO/ # control socket access
        └── util/     # decorator & mail module & constants

❓ Usage

☝🏻 Clone git repository

$ git clone https://github.com/dino9881/42T.git

✌🏻 Fill in Environment Variables

You have to fill in the env values and change the file name from .env_sample to .env. For example..

# Node Mailer Options 
MAIL_USER=[YOUR EMAIL ID]
MAIL_PASSWORD=[YOUR EMAIL APP PASSWORD]
MAIL_HOST=[YOUR EMAIL HOST]
MAIL_PORT=[YOUR EMAIL HOST PORT]
MAIL_FROM=[YOUR EMAIL FROM]

🖐 Execute

To run containers in the background mode...

$ make

See what is happening in the containers...

$ make log

🤝 Rule

Commit Rules

[part][type] : #(issue) title body ex) [FE][Fix] : #1234 로그인 페이지- 로그인이 안되는 버그 수정

commit part

• [FE] : frontend
• [BE] : backend
• [CM] : common

commit type

• [Feat] : 새로운 기능을 추가
• [Fix] : 버그 수정
• [Docs] : 문서 수정
• [Design] : CSS등 사용자 UI디자인 변경
• [Style] : 코드 수정 없이 코드의 포맷 변경(ex 세미콜론 누락)
• [Refactor] : 배포 코드 리팩토링
• [Comment] : 주석 추가 및 변경
• [Merge] : 풀리퀘스트 머지
• [Remove] : 파일 삭제 작업
• [Rename] : 파일 / 폴더 명 변경 또는 위치 이동
• [Test] : 테스트 코드 작성 및 리팩토링