Skip to content

๐Ÿน ์นตํ…Œ์ผ์— ๋Œ€ํ•œ ๋ชจ๋“  ๊ฒƒ

Notifications You must be signed in to change notification settings

Cocktailer-Elice/cocktailer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Elice Team04 Project - Cocktailer

cocktail-title

์„œ๋น„์Šค ์†Œ๊ฐœ

์นตํ…Œ์ผ์˜ ์ฒœ๊ตญ - ์นตํ…Œ์ผ๋Ÿฌ (COCKTAILER) ๐Ÿธ

๋ชจ๋“  ์นตํ…Œ์ผ์˜ ๋ ˆ์‹œํ”ผ์™€ ์นตํ…Œ์ผ์„ ์‚ฌ๋ž‘ํ•˜๋Š” ์‚ฌ๋žŒ๋“ค์ด ๋ชจ์ธ ์žฅ์†Œ์ž…๋‹ˆ๋‹ค.


๋งค์ผ ๋‹ฌ๋ผ์ง€๋Š” ์นตํ…Œ์ผ ๋ ˆ์‹œํ”ผ๋ฅผ ์ถ”์ฒœ ๋ฐ›๊ณ  ์‹ถ์–ด ํ•˜๋Š” ์‚ฌ๋žŒ
๋‚˜๋งŒ์˜ ๋ ˆ์‹œํ”ผ๋ฅผ ๊ณต์œ ํ•˜๊ณ  ์‹ถ์€ ์‚ฌ๋žŒ
์นตํ…Œ์ผ์„ ์ฃผ์ œ๋กœ ๋‹ค์–‘ํ•œ ์‚ฌ๋žŒ๋“ค๊ณผ ์†Œํ†ตํ•˜๊ณ  ์‹ถ์€ ์‚ฌ๋žŒ

์นตํ…Œ์ผ๋Ÿฌ <<< ์—ฌ๊ธฐ๋กœ ๋ชจ์ด์„ธ์š”! ๐Ÿ–

๊ฒฐ๊ณผ๋ฌผ

4๋ถ„ ์‹œ์—ฐ ์˜์ƒ

Description

๋‹ค์–‘ํ•œ ์นตํ…Œ์ผ ๋ ˆ์‹œํ”ผ๋“ค์„ ํ•˜๋‚˜์˜ ์‚ฌ์ดํŠธ์— ๋ชจ์—ฌ์žˆ์–ด ํ•œ๋ฒˆ์— ์ ‘๊ทผ ๊ฐ€๋Šฅํ•˜๋„๋ก ํ•˜๋Š” ์›น ์‚ฌ์ดํŠธ ์ž…๋‹ˆ๋‹ค. ์›น ๋ฐ ๋ชจ๋ฐ”์ผ ํ™˜๊ฒฝ์— ์ตœ์ ํ™” ๋˜์–ด ์žˆ์œผ๋ฉฐ ์‰ฝ๊ฒŒ ์‚ฌ์ดํŠธ์— ์ ‘์†์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

ํด๋ผ์ด์–ธํŠธ ์ฃผ์š” ๊ธฐ๋Šฅ

  • ์‚ฌ์šฉ์ž๋Š” ํšŒ์›๊ฐ€์ž… ๋ฐ ๋กœ๊ทธ์ธ์ด ๊ฐ€๋Šฅํ•˜๊ณ  ์ž๋™ ๋กœ๊ทธ์ธ, ๋ณธ์ธ์ธ์ฆ, ๋ฐ”ํ…๋” ์ธ์ฆ์„ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ๋‹ค์–‘ํ•œ ์นดํ…Œ๊ณ ๋ฆฌ๋ณ„ ์นตํ…Œ์ผ ๋ ˆ์‹œํ”ผ๋ฅผ ํ™•์ธ ํ•  ์ˆ˜ ์žˆ๊ณ  ๋‚˜๋งŒ์˜ ๋ ˆ์‹œํ”ผ ๋“ฑ๋ก, ์ˆ˜์ •, ์‚ญ์ œ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ๋‹ค์–‘ํ•œ ์‚ฌ๋žŒ๋“ค๊ณผ ์นตํ…Œ์ผ์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ๊ตํ™˜ํ•˜๋ฉฐ ๋Œ“๊ธ€, ๋Œ€๋Œ“๊ธ€, ๋Œ“๊ธ€ ์ฑ„ํƒ์„ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ๋‚˜์˜ ๊ธฐ๋ถ„, ๋‚ ์”จ ๋“ฑ๋“ฑ ๋‹ค์–‘ํ•œ ์š”์†Œ๋ฅผ ๊ณ ๋ คํ•˜์—ฌ ์นตํ…Œ์ผ์„ ์ถ”์ฒœ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • react-hook-form์„ ์ด์šฉํ•ด ๋กœ๊ทธ์ธ / ํšŒ์›๊ฐ€์ž… ๊ฒ€์ฆ์„ ์ฒ˜๋ฆฌํ•˜์˜€์Šต๋‹ˆ๋‹ค.
  • chart.js ๋ฅผ ํ™œ์šฉํ•˜์—ฌ ์นตํ…Œ์ผ ์žฌ๋ฃŒ๋“ค์„ ์‹œ๊ฐํ™” ํ•˜์˜€์Šต๋‹ˆ๋‹ค.
  • redux-toolkit์„ ํ™œ์šฉํ•˜์—ฌ ๋กœ๊ทธ์ธ/ํšŒ์›๊ฐ€์ž…, ์นตํ…Œ์ผ ๋ ˆ์‹œํ”ผ ๋“ฑ๋ก, ์นต๊ณ ๋ฆฌ์ฆ˜ ๊ธฐ๋Šฅ์„ ์ˆ˜ํ–‰ํ•˜์˜€์Šต๋‹ˆ๋‹ค.

์„œ๋ฒ„ ์ฃผ์š” ๊ธฐ๋Šฅ

  • ์‚ฌ์šฉ์ž๊ฐ€ ํšŒ์›๊ฐ€์ž… ์‹œ ๋žœ๋ค ๋‹‰๋„ค๋‹˜ ์ƒ์„ฑ์„ ํ•ฉ๋‹ˆ๋‹ค.
  • ํšŒ์›๊ฐ€์ž… ์‹œ ์ „ํ™”๋ฒˆํ˜ธ ์ธ์ฆ๊ณผ ์ด๋ฉ”์ผ ์ค‘๋ณต์„ ํ™•์ธ ํ•ฉ๋‹ˆ๋‹ค.
  • ๊ฒŒ์‹œ๋ฌผ ๋Œ“๊ธ€๊ณผ ๋Œ€๋Œ“๊ธ€์„ ๋‹ฌ๊ณ  ๋Œ“๊ธ€์„ ์ฑ„ํƒํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ํ”„๋ก ํŠธ ๋‹จ์—์„œ ์ด๋ฏธ์ง€๋ฅผ s3์— ์—…๋กœ๋“œ ํ•œ ํ›„ ํ‚ค ๊ฐ’์„ ์ด์šฉํ•ด ์„œ๋ฒ„์— ์ €์žฅํ•˜์—ฌ ๋‹ค์‹œ ๋‚ด๋ ค์ค๋‹ˆ๋‹ค.
  • ์•Œ๊ณ ๋ฆฌ์ฆ˜์„ ์ด์šฉํ•˜์—ฌ ์‚ฌ์šฉ์ž์— ๋งž๋Š” ์นตํ…Œ์ผ์„ ์ถ”์ฒœํ•ด์ค๋‹ˆ๋‹ค.

TEST ๊ณ„์ •

API Document

POSTMAN API Doc

Skills

FRONT

BACK


Member

์ด๋ฆ„ ๋‹ด๋‹น ์—ญํ•  ๋‹ด๋‹น ์—…๋ฌด
์†์ข…ํ›ˆ ํ”„๋ก ํŠธ์—”๋“œ ๋ฉ”์ธ ํŽ˜์ด์ง€, ์นต๊ณ ๋ฆฌ์ฆ˜ ํŽ˜์ด์ง€
์„œ์•„๋ฆ„ ํ”„๋ก ํŠธ์—”๋“œ ์นตํ”Œ๋กœ์šฐ ๊ฒŒ์‹œ๋ฌผ, ๋Œ“๊ธ€ crud
์˜คํ˜„์„ ํ”„๋ก ํŠธ์—”๋“œ ๋กœ๊ทธ์ธ, ํšŒ์›๊ฐ€์ž…, ๋งˆ์ดํŽ˜์ด์ง€
ํ•œ์„ธ์€ ํ”„๋ก ํŠธ์—”๋“œ ์นตํ…Œ์ผ ๋ ˆ์‹œํ”ผ crud, ์ข‹์•„์š”, ์นด์นด์˜คํ†ก ๊ณต์œ ํ•˜๊ธฐ
๊น€๊ฑด์šฐ ๋ฐฑ์—”๋“œ ์œ ์ €, ๋ฉ”์ธ
์˜ค์ธ๊ตญ ๋ฐฑ์—”๋“œ ์นต๊ณ ๋ฆฌ์ฆ˜, ์นต์‹œํ”ผ

Architecture

infra

stack

์ฃผ์š” ํ™”๋ฉด

๋ฉ”์ธ ํŽ˜์ด์ง€ ํšŒ์›๊ฐ€์ž… ํŽ˜์ด์ง€
๋กœ๊ทธ์ธ ํŽ˜์ด์ง€ ์นต์‹œํ”ผ ํŽ˜์ด์ง€
์นตํ”Œ๋กœ์šฐ ํŽ˜์ด์ง€ ์นต๊ณ ๋ฆฌ์ฆ˜ ํŽ˜์ด์ง€
๋งˆ์ด ํŽ˜์ด์ง€ (ํšŒ์›์ •๋ณด ์ˆ˜์ • ๋ฐ ์ž‘์„ฑํ•œ ๊ฒŒ์‹œ๊ธ€) ๋งˆ์ด ํŽ˜์ด์ง€ (ํƒˆํ‡ดํ•˜๊ธฐ)


Commit Convention

option content
Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ถ”๊ฐ€ํ•  ๊ฒฝ์šฐ
Fix ๋ฒ„๊ทธ๋ฅผ ๊ณ ์นœ ๊ฒฝ์šฐ
Design CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ
!BREAKING CHANGE ์ปค๋‹ค๋ž€ API ๋ณ€๊ฒฝ์˜ ๊ฒฝ์šฐ
!HOTFIX ๊ธ‰ํ•˜๊ฒŒ ์น˜๋ช…์ ์ธ ๋ฒ„๊ทธ๋ฅผ ๊ณ ์ณ์•ผํ•˜๋Š” ๊ฒฝ์šฐ
Style ์ฝ”๋“œ ํฌ๋งท ๋ณ€๊ฒฝ, ์„ธ๋ฏธ ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ์ˆ˜์ •์ด ์—†๋Š” ๊ฒฝ์šฐ
Rename ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ์ธ ๊ฒฝ์šฐ
Remove ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ
Chore ์ง„์งœ ์ž์ž˜ํ•œ ๋ณ€๊ฒฝ(์˜คํƒ€, ์ค„ ๋ณ€๊ฒฝ ๋“ฑ)
Setting ๊ฐœ๋ฐœ ํ™˜๊ฒฝ์„ ์„ค์ •ํ•˜๋Š” ๊ฒฝ์šฐ


์‹คํ–‰ ๋ฐฉ๋ฒ•

  1. ๋ฆฌํฌ์ง€ํ„ฐ๋ฆฌ๋ฅผ ํด๋ก  ๋ฐ›์Šต๋‹ˆ๋‹ค.
git clone <repository address>
  1. Backend ํด๋”์™€ Frontend ํด๋” ๋‘˜ ๋‹ค ๋“ค์–ด๊ฐ€ ์•„๋ž˜ ๋ช…๋ น์–ด๋กœ ํ•„์š”ํ•œ ํŒจํ‚ค์ง€๋“ค์„ ์„ค์น˜ํ•ฉ๋‹ˆ๋‹ค. (์ตœ์ƒ์œ„ ๊ฒฝ๋กœ์—์„œ yarn ํ•˜๋ฉด ์„ค์น˜๊ฐ€ ์•ˆ๋ฉ๋‹ˆ๋‹ค.)
yarn
  1. Backend ํด๋”์™€ Frontend ํด๋” ๋‘˜ ๋‹ค ์•„๋ž˜ ๋ช…๋ น์–ด๋กœ ํ”„๋กœ์ ํŠธ๋ฅผ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค.
yarn dev
  1. Backend ํด๋”์™€ Frontend ํด๋” ๋‘˜ ๋‹ค ์•„๋ž˜ ๋ช…๋ น์–ด๋กœ ํ”„๋กœ์ ํŠธ๋ฅผ ๋นŒ๋“œํ•ฉ๋‹ˆ๋‹ค.
yarn build
  • Backend .env ํŒŒ์ผ
# PORT
PORT=

# MODE
NODE_ENV=

# DB
MONGO_URL=
MONGO_URL_COMPASS=
REDIS_USERNAME=
REDIS_PW=
REDIS_URL=
REDIS_PORT=

# AWS S3
S3_ID=
S3_SECRET=

# TOKEN
ACCESS_KEY=
ACCESS_EXPIRE=
ACCESS_EXPIRE_AUTO=
REFRESH_EXPIRE=
COOKIE_EXPIRE=

# SENS
SENS_ID=
SENS_ACCESS_KEY=
SENS_SECRET_KEY=
SENS_FROM=

# GMAIL
GMAIL_ID=
GMAIL_PW=
  • Frontend .env ํŒŒ์ผ
VITE_APP_KAKAO=

About

๐Ÿน ์นตํ…Œ์ผ์— ๋Œ€ํ•œ ๋ชจ๋“  ๊ฒƒ

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages