๐ฉธ bloodtrail-be
๐คbloodtrail-be๐ค
bloodtrail backend repository
1๏ธโฃ Rules
#ํํ # ์ปค๋ฎค๋ํฐ
Blood์ Trail์ ํฉ์ฑ์ด๋ก ํํ ํ ์ด๋ํ๋ ํผ๋ฅผ ๋ณด๋ฉฐ ํผ์ ์์ทจ(๊ธธ)๋ผ๋ ์๋ฏธ๋ฅผ ๋ด์ ํ๋ช ์ Blood Trail๋ก ์ ํ๊ฒ ๋์์ต๋๋ค.
๐จ๐ปโ๐ป ํ์ ์๊ฐ
| ํํธ | ์ด๋ฆ | ํฌ์ง์ |
|---|---|---|
| ๋ฐฑ์๋ | ์ ์ฑ์ | ์๋ฒ ๋ฐฐํฌ, DB ๋ฐ API ๊ตฌ์ถ |
| ๋ฐฑ์๋ | ๊น์ง์ | DB ๋ฐ API ๊ตฌ์ถ |
| ๋ฐฑ์๋ | ๋จ๊ตฌ๋ฏผ | DB ๋ฐ API ๊ตฌ์ถ |
๐ป Technology
๐ป System Architecture
๐ Rules
- ISSUE ์์ฑ > develop์์ ๋ธ๋์น ๋ถ๊ธฐ
- develop์ผ๋ก๋ง PR ๋ ๋ฆฌ๊ธฐ > PR ๋ ๋ฆฐ ํ dev action ํต๊ณผ ํ์ธ
- dev action ํต๊ณผ ํ์ธํ๋ฉด main์ผ๋ก PR!
- ๋ฐฐํฌ ์๋ฃ๋๋ฉด health ์ฒดํฌ ํ์ธ
- env ํ์ผ ์์ ํ ์นดํก์ผ๋ก ๊ณต์
- env ํ์ผ ์์ ํ ๋ ธ์ ์ผ๋ก ๊ณต์
2๏ธโฃ Commit Message Convention
๐๏ธ Commit Convetion
์ปค๋ฐํ๊ทธ(# ์ด์๋ฒํธ) : ๋ด์ฉ ex. `feat(#2) : CI/CD ํ์ดํ๋ผ์ธ ์์ฑ'
์ปค๋ฐํ๊ทธ(# ์ด์๋ฒํธ) : ๋ด์ฉ ex. `deploy(#2) : CI/CD ํ์ดํ๋ผ์ธ ์์ฑ'
| command | mean |
|---|---|
| feat | ๊ธฐ๋ฅ ๊ฐ๋ฐ |
| bug | ๋ฒ๊ทธ ์์ |
| docs | ๋ฌธ์ ์์ (README.md ๋ฑ) |
| deploy | ๋ฐฐํฌ ๊ด๋ จ |
| test | ํ ์คํธ ์ฝ๋ ์ถ๊ฐ |
| refactor | ์ฝ๋ ๋ฆฌํฉํ ๋ง |
| setting | ๊ฐ๋ฐ ํ๊ฒฝ ์ ํ |
| chore | ๋น๋, ํจํค์ง ๋งค๋์ ์์ |
| command | mean |
|---|---|
| feat | ๊ธฐ๋ฅ ๊ฐ๋ฐ |
| bug | ๋ฒ๊ทธ ์์ |
| docs | ๋ฌธ์ ์์ (README.md ๋ฑ) |
| deploy | ๋ฐฐํฌ ๊ด๋ จ |
| test | ํ ์คํธ ์ฝ๋ ์ถ๊ฐ |
| refactor | ์ฝ๋ ๋ฆฌํฉํ ๋ง |
| setting | ๊ฐ๋ฐ ํ๊ฒฝ ์ ํ |
| chore | ๋น๋, ํจํค์ง ๋งค๋์ ์์ |
๐ Directory Structure
โโโ node_modules
โโโ src
โ โโโ config // ์ค์ ํ์ผ
โ โโโ controller // API ์์ฒญ ์ฒ๋ฆฌ
โ โโโ middleware // API ๋งค๊ฐ ์ญํ
โ โโโ public // css์ ์งํฉ
โ โโโ router // API ๋ผ์ฐํ
โ โโโ schema // ๋ฐ์ดํฐ๋ฒ ์ด์ค ์คํค๋ง
โโโโโโโ view // API ํ
์คํธ ๋ทฐ (.ejs์ ์งํฉ)
โโโ .ebextensions
โโโ Procfile
โโโ index.js
โโโ package.json
โโโ package-lock.json
โโโ webpack.config.js