Skip to content

๐Ÿ˜ฝ์•ผ์šฉ...๋ƒฅ๋ƒฅ๐Ÿ˜บ๋ƒฅ๋ƒฅ ์•ผ์šฉ๐Ÿ˜ผ ๋ƒฅ๋ƒ์•™!!!!๐Ÿ˜พ๐Ÿ˜ป๐Ÿ˜น

Notifications You must be signed in to change notification settings

TeamMascota/Mascota-Server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

zMascota-Server

์•ผ์šฉ...๋ƒฅ๋ƒฅ๐Ÿ˜บ


MASCOTA_๋กœ๊ณ 

๐Ÿ”จ Avengers

์ด์†” ์ดํ˜„์ข… ๊ฐ•์ˆ˜๋ฏธ
image image image

mascota_orange

๐Ÿผ ํ”„๋กœ์ ํŠธ ์„ค๋ช…

"์ถ”์–ต์€ ์˜์›ํ•ด๋„ ์Šฌํ””์€ ์˜์›ํ•˜์ง€ ์•Š์œผ๋‹ˆ๊นŒ"

- ํ•œ๊ถŒ์˜ ์ฑ…์œผ๋กœ ์ •๋ฆฌํ•˜๋Š” ๋ฐ˜๋ ค๋™๋ฌผ์˜ ์‚ถ๊ณผ ์ฃฝ์Œ ์ฃผ ๊ธฐ๋Šฅ :

[1๋ถ€]

1) ๋ฐ˜๋ ค๋™๋ฌผ๊ณผ ์ด๋ณ„์„ ์ค€๋น„ํ•˜๋Š” ๊ณผ์ •์„ ํ•œ ๊ถŒ์˜ ์ฑ…์„ ์ง‘ํ•„

2) ๋ฐ˜๋ ค ๋™๋ฌผ์˜ ์ผ์ƒ ๊ธฐ๋ก

3) ๊ฑด๊ฐ•์ด๋‚˜ ๋ฐ˜๋ ค๋™๋ฌผ์˜ ์ฃฝ์Œ์— ๊ด€๋ จ๋œ ์ •๋ณด ์ œ๊ณต

2๋ถ€]

4) ์ด๋ณ„ ํ›„, ๋ฐ˜๋ ค๋™๋ฌผ๊ณผ์˜ ์ผ์ƒ์„ ๋ชจ์•„ ํšŒ๊ณ 

5) ์ž‘๊ฐ€์˜ ๊ฐ์ •์„ ๊ธฐ๋กํ•˜๊ณ  ๋Œ€์ฒ˜๋ฒ• ์ œ๊ณต

-> ์ฃฝ์Œ์— ๋Œ€ํ•œ ๊ฑฐ๋ถ€๊ฐ์„ ์ค„์ด๊ณ  ์ค€๋น„์˜ ํ•„์š”์„ฑ์„ ๋†’์ธ๋‹ค.


โฃ Feature

๐ŸŒบ 1๋ถ€ - ์†”


[POST]๋กœ๊ทธ์ธ API

[POST]ํšŒ์›๊ฐ€์ž… API

[POST]๋ฐ˜๋ ค๋™๋ฌผ ๋“ฑ๋ก API

[POST]ํ”„๋กค๋กœ๊ทธ ์ž‘์„ฑ API

[GET] 1๋ถ€ ํ™ˆ ํ™”๋ฉด API

[POST] ๋ฐ˜๋ ค๋™๋ฌผ ์ผ๊ธฐ ์ž‘์„ฑ API

[GET]์ผ๊ธฐ ์กฐํšŒ API

[PUT]์ผ๊ธฐ ์ˆ˜์ • API

[DELETE] ์ผ๊ธฐ ์‚ญ์ œ API

[GET] ๋ชฉ์ฐจ๋ณ„ ์ผ๊ธฐ ์กฐํšŒ API

[GET] ๋ชฉ์ฐจ ๋ฆฌ์ŠคํŠธ API

[POST] ๋ชฉ์ฐจ ์ถ”๊ฐ€ API

[PUT] ๋ชฉ์ฐจ ์ˆ˜์ • API

[DELETE] ๋ชฉ์ฐจ ์‚ญ์ œ API

[GET] ๋ฐ˜๋ ค๋™๋ฌผ ์ •๋ณด API - new


๐ŸŒท 1.5 ๋ถ€ - ๋ฆฌ๋“œ ํ˜€๋‹ˆ


[Get]1.5๋ถ€ ๋ฌด์ง€๊ฐœ ํ™ˆ ํ™”๋ฉดAPI

[Put] 1.5๋ถ€ ๋ฌด์ง€๊ฐœ ๋ฐ˜๋ ค๋™๋ฌผ ์ ์šฉ API& 1.5๋ถ€ ๋ฌด์ง€๊ฐœ ๋ฐ˜๋ ค๋™๋ฌผ ๋ฌด์ง€๊ฐœ ๋‹ค๋ฆฌ ๋ฉ˜ํŠธAPI

[Delete] 1.5๋ถ€ ๋ฌด์ง€๊ฐœ ์ด๋ณ„์ค€๋น„ ์ทจ์†Œํ•˜๊ธฐ

[Get]1.5๋ถ€ ๋ฌด์ง€๊ฐœ ์ด๋ณ„์— ์ค€๋น„ํ•˜๋Š” ์ž‘๊ฐ€์˜ ๊ธฐ๋ก ์‹œ์ž‘ API

[Get]1.5๋ถ€ ๋ฌด์ง€๊ฐœ ์ตœ๊ณ ์˜ ์ˆœ๊ฐ„ API

[Get] 1.5๋ถ€ ๋ฌด์ง€๊ฐœ ์ž‘๊ฐ€์˜ ๋ง ์ž‘์„ฑ ์‹œ ๋ฐ˜๋ ค๋™๋ฌผ ์ด๋ฆ„ ๋ถˆ๋Ÿฌ์˜ค๊ธฐ API

[Post]1.5๋ถ€ ๋ฌด์ง€๊ฐœ ์ž‘๊ฐ€์˜ ๋ง - ์—ํ•„๋กœ๊ทธ API

[Get] 1.5๋ถ€ ๋ฌด์ง€๊ฐœ ์„œ๋ธŒ ํ™ˆ API

[Get] ์บ˜๋ฆฐ๋” ๋ทฐ API


๐ŸŒน 2๋ถ€ - ์ˆ˜ ๋ฏธ (ํ™ˆ/๋ชฉ์ฐจ - ํ˜€๋‹ˆ, ์ผ๊ธฐ - ์†”)

[GET]2๋ถ€ ํ™ˆํ™”๋ฉด API

[GET]๋ชฉ์ฐจ๋ณ„ ์ผ๊ธฐ์กฐํšŒAPI

[GET] 2๋ถ€ ๋ชฉ์ฐจ ๋ฆฌ์ŠคํŠธ API

[Post] 2๋ถ€ ๋ชฉ์ฐจ ์ถ”๊ฐ€ API

[PUT] 2๋ถ€ ๋ชฉ์ฐจ ์ˆ˜์ • API

[DELETE] ๋ชฉ์ฐจ ์‚ญ์ œ API

[POST] ์ž‘๊ฐ€ ์ผ๊ธฐ ์ž‘์„ฑ API

[GET]์ž‘๊ฐ€์ผ๊ธฐ ์กฐํšŒ API

[PUT]์ž‘๊ฐ€์ผ๊ธฐ ์ˆ˜์ • API

[DELETE] ์ž‘๊ฐ€์ผ๊ธฐ ์‚ญ์ œ API

[GET]๋Œ€์ฒ˜๋ฒ• API - ๋ฆด๋ฆฌ์ฆˆ

[GET]๋„์›€ ๊ธฐ๊ด€ ์—ฐ๊ฒฐAPI - ๋ฆด๋ฆฌ์ฆˆ

[GET]๋งˆ์ดํŽ˜์ด์ง€API - ๋ฆด๋ฆฌ์ฆˆ

๐Ÿจ ์„œ๋ฒ„ ์•„ํ‚คํ…์ฒ˜

image


๐ŸŽ package.json

{
  "name": "mascota_server",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "dev": "ts-node src",
    "build": "tsc && node dist",
    "test": "nodemon"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@types/node": "^15.12.5",
    "ts-node": "^10.0.0",
    "typescript": "^4.3.4"
  },
  "dependencies": {
    "@types/express": "^4.17.12",
    "bcryptjs": "^2.4.3",
    "dotenv": "^10.0.0",
    "express": "^4.17.1",
    "mongoose": "^5.13.0",
    "nodemon": "^2.0.9"
  }
}

๐Ÿ–ฅ Code convention


Code Convention

*ํ•ญ์ƒ ์ฝ”๋“œ ์ž‘์„ฑ ์ค‘์— ctrl + k + f ๋กœ ์ฝ”๋“œ ์ค„ ์ •๋ ฌ ํ•„์ˆ˜!!


๐ŸคManage Commit, Branch Strategies


1.Git branch

main
   |
   |--- develop
   |--- feature/ํ˜„์ข…
   |--- feature/์†”
   |--- feature/์ˆ˜๋ฏธ

2.Git - flow

  • main : ๋ฐฐํฌ ๋ธŒ๋žœ์น˜
  • develop : main์œผ๋กœ ๋ณด๋‚ด๊ธฐ ์ „ ๋ธŒ๋žœ์น˜, feature์—์„œ ์ž‘์—…ํ•œ ๋ธŒ๋žœ์น˜์™€ ๋‹ค๋ฅธ ์‚ฌ๋žŒ์ด ์ž‘์—…ํ•œ ๋ธŒ๋žœ์น˜๋ฅผ mergeํ•˜๋Š” ๋ธŒ๋žœ์น˜
  • feature : ํ• ๋‹น๋œ ์ž‘์—…์„ ๊ฐœ์ธ์ ์œผ๋กœ ์ˆ˜ํ–‰ํ•˜๋Š” ๋ธŒ๋žœ์น˜
    • feature/์ด๋ฆ„/๊ธฐ๋Šฅ๋ช…
    • ์˜ˆ์‹œ : feature/hyunjong/login
  • Reference

3. Git Commit Message Convention

  • ์ œ๋ชฉ
Title Content
feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์ถ”๊ฐ€
refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
fix ๋ฒ„๊ทธ ์ˆ˜์ •
  • ๋ณธ๋ฌธ

  • ์˜ˆ์‹œ

    • ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€

      feat : ์ผ๊ธฐ ์ƒ์„ธ๋ณด๊ธฐ ๊ธฐ๋Šฅ ๊ตฌํ˜„
      - get๋ฉ”์†Œ๋“œ๋ฅผ ์ด์šฉ
      - ์ผ๊ธฐDB์—์„œ ๋ชฉ์ฐจid๋ฅผ ํ†ตํ•ด ์ผ๊ธฐ๋ฅผ ๊ฐ€์ ธ์˜ด
      
    • ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง

      refactor : ํ™ˆ๋ทฐ ๋ฐ์ดํ„ฐ ๋ฐ˜ํ™˜๊ฐ’ ์ˆ˜์ •
      -๋ฐ˜ํ™˜๋ฐ์ดํ„ฐ์— ๋ฐ˜๋ ค๋™๋ฌผ img ์ถ”๊ฐ€
      

4. User Flow

Mascota Work Flow 2 Mascota Work Flow 3 Mascota Work Flow 4 Mascota Work Flow 5 Mascota Work Flow 6

About

๐Ÿ˜ฝ์•ผ์šฉ...๋ƒฅ๋ƒฅ๐Ÿ˜บ๋ƒฅ๋ƒฅ ์•ผ์šฉ๐Ÿ˜ผ ๋ƒฅ๋ƒ์•™!!!!๐Ÿ˜พ๐Ÿ˜ป๐Ÿ˜น

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published