Skip to content

lostparty-team/lp_project

Repository files navigation

๐Ÿš€ ๋กœ์ŠคํŠธํŒŒํ‹ฐ (LostParty)

Badge License Status

๐Ÿ—“๏ธ ๊ฐœ๋ฐœ ๊ธฐ๊ฐ„

  • 2024.12 ~ 2025.03

๐ŸŽฎ ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ

๋กœ์ŠคํŠธํŒŒํ‹ฐ๋Š” ๊ฒŒ์ž„ ๋กœ์ŠคํŠธ์•„ํฌ์—์„œ ํŒŒํ‹ฐ์›์˜ ๋‹‰๋„ค์ž„์„ ํ™”๋ฉด ๊ณต์œ  ๋ฐ OCR ๊ธฐ์ˆ ์„ ํ™œ์šฉํ•ด ๊ฐ์ง€ํ•˜๊ณ , ์ด๋ฅผ ๋ธ”๋ž™๋ฆฌ์ŠคํŠธ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค์™€ ๋น„๊ตํ•˜์—ฌ ์•…์„ฑ ์œ ์ € ์—ฌ๋ถ€๋ฅผ ๊ฒ€์ฆํ•˜๊ณ , ํŒŒํ‹ฐ์›์˜ ์•„์ดํ…œ ์ •๋ณด๋ฅผ ๊ฐ€๊ณตํ•˜์—ฌ ์ œ๊ณตํ•ด์ฃผ๋Š” ์›น ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค.

๐Ÿ–ผ๏ธ ๋ฐ๋ชจ ํ™”๋ฉด

home

๐Ÿ—‚๏ธ ERD ๋‹ค์ด์–ด๊ทธ๋žจ

๋ณธ ํ”„๋กœ์ ํŠธ์—์„œ ์‚ฌ์šฉ๋œ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๊ตฌ์กฐ๋Š” ์•„๋ž˜์˜ ERD(Entity Relationship Diagram)๋ฅผ ํ†ตํ•ด ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

โœจ ์ฃผ์š” ๊ธฐ๋Šฅ

๐Ÿ”Ž 1. ๋‹‰๋„ค์ž„ ๊ฐ์ง€ (OCR)

  • ํ™”๋ฉด ๊ณต์œ ๋ฅผ ํ†ตํ•ด ํŒŒํ‹ฐ์›์˜ ๋‹‰๋„ค์ž„์„ ์ž๋™์œผ๋กœ ๊ฐ์ง€ํ•ฉ๋‹ˆ๋‹ค.
  • PaddleOCR๋ฅผ ํ™œ์šฉํ•œ OCR ๊ธฐ์ˆ ๋กœ ํŒŒํ‹ฐ์› ๋‹‰๋„ค์ž„์„ ์ถ”์ถœํ•ฉ๋‹ˆ๋‹ค.

๐Ÿ“‹ 2. ํŒŒํ‹ฐ์› ์ •๋ณด ์ถ”์ถœ (API)

  • ์ถ”์ถœ๋œ ๋‹‰๋„ค์ž„์„ ํ†ตํ•ด LOSTARK API ๋ฅผ ์ด์šฉํ•˜์—ฌ ์ œ๊ณต๋ฐ›์€ ํŒŒํ‹ฐ์›์˜ ์บ๋ฆญํ„ฐ ์ •๋ณด๋ฅผ ๊ฐ€๊ณตํ•˜์—ฌ ์‚ฌ์šฉ์ž์—๊ฒŒ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.
  • LOSTARK์—์„œ ์ œ๊ณตํ•œ OPENAPI๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

โš ๏ธ 3. ๋ธ”๋ž™๋ฆฌ์ŠคํŠธ ์กฐํšŒ

  • ์ถ”์ถœ๋œ ๋‹‰๋„ค์ž„์ด ๋ธ”๋ž™๋ฆฌ์ŠคํŠธ์— ๋“ฑ๋ก๋œ ์œ ์ €์ธ์ง€ ์‹ค์‹œ๊ฐ„์œผ๋กœ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค.
  • ๋“ฑ๋ก๋œ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๊ธฐ๋ฐ˜์œผ๋กœ ์กฐํšŒ๊ฐ€ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

๐Ÿ“‹ 4. ๋ธ”๋ž™๋ฆฌ์ŠคํŠธ ๋“ฑ๋ก ๋ฐ ๊ด€๋ฆฌ

  • ์‚ฌ์šฉ์ž๊ฐ€ ์ง์ ‘ ์•…์„ฑ ์œ ์ €๋ฅผ ๋ธ”๋ž™๋ฆฌ์ŠคํŠธ์— ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
  • ๋“ฑ๋ก๋œ ์‚ฌ์šฉ์ž ๋ชฉ๋ก ๊ฒ€์ƒ‰ ๋ฐ ์ถ”๊ฐ€๋ฅผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿงฎ ๋กœ์ŠคํŠธํŒŒํ‹ฐ ์‚ฌ์šฉ ๋ฐฉ๋ฒ•

ํŽ˜์ด์ง€ ์ด๋ฏธ์ง€ ์„ค๋ช…
๋ฉ”์ธํ™”๋ฉด ์„œ๋น„์Šค์˜ ๋ฉ”์ธํ™”๋ฉด์œผ๋กœ, ์ „์ฒด์ ์ธ UI์™€ ์ฃผ์š” ๊ธฐ๋Šฅ์„ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
APIํ‚ค ์ž…๋ ฅ API ํ‚ค๋ฅผ ์ž…๋ ฅํ•˜์—ฌ ์ธ์ฆ์„ ์™„๋ฃŒํ•˜๋Š” ํŽ˜์ด์ง€์ž…๋‹ˆ๋‹ค.
๋ธ”๋ž™๋ฆฌ์ŠคํŠธ ํŽ˜์ด์ง€ ๋ธ”๋ž™๋ฆฌ์ŠคํŠธ ๋ชฉ๋ก์„ ํ™•์ธํ•˜๊ณ  ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
๋ธ”๋ž™๋ฆฌ์ŠคํŠธ ์ž‘์„ฑ ๋ฐ ์ ์šฉ ์ƒˆ๋กœ์šด ๋ธ”๋ž™๋ฆฌ์ŠคํŠธ๋ฅผ ์ž‘์„ฑํ•˜๊ณ  ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.
์ธ๊ฒŒ์ž„ ํŒŒํ‹ฐ ๊ตฌ์ธ์ฐฝ ๊ฒŒ์ž„ํ™”๋ฉด์„ ์ธ์‹ํ•˜์—ฌ ํŒŒํ‹ฐ ์‹ ์ฒญ์ž์˜ ๋‹‰๋„ค์ž„์„ ์ถ”์ถœํ•ฉ๋‹ˆ๋‹ค.
ํŒŒํ‹ฐ์› ์ •๋ณด ํŒŒํ‹ฐ ์‹ ์ฒญ์ž์˜ ์ŠคํŽ™ ๋ฐ ์ •๋ณด๋ฅผ ์ง๊ด€์ ์œผ๋กœ ํŒŒ์•…ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
API ๋ฌธ์„œ ๋กœ์ŠคํŠธ์•„ํฌ ํŒŒํ‹ฐ ๋งค์นญ ์›น์„œ๋น„์Šค์˜ API ๋ฌธ์„œ์ž…๋‹ˆ๋‹ค. ๋‹‰๋„ค์ž„ ๊ธฐ๋ฐ˜ ์บ๋ฆญํ„ฐ ์ •๋ณด ์กฐํšŒ, ๋ธ”๋ž™๋ฆฌ์ŠคํŠธ ๊ด€๋ฆฌ ๊ธฐ๋Šฅ ๋“ฑ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

๐Ÿ—๏ธ ๊ธฐ์ˆ  ์Šคํƒ

๋ถ„์•ผ ๊ธฐ์ˆ  ์Šคํƒ
Frontend Next.js, TypeScript
Backend Express.js, Nest.js
Database MySQL
OCR PaddleOCR
DevOps Docker, AWS
Communication Notion, KakaoTalk

๐Ÿ“ฆ ์„ค์น˜ ๋ฐ ์‹คํ–‰ ๋ฐฉ๋ฒ• (๊ฐœ๋ฐœ ํ™˜๊ฒฝ)

# 1. ํ”„๋กœ์ ํŠธ ํด๋ก 
git clone https://github.com/HaeSung99/lp_project.git
cd lp_project

# 2. Docker ๋ฐ Docker Compose ์„ค์น˜ (์„ค์น˜๋˜์–ด ์žˆ์ง€ ์•Š์€ ๊ฒฝ์šฐ)

# 3. ํ™˜๊ฒฝ ๋ณ€์ˆ˜ ํŒŒ์ผ ์ž‘์„ฑ (.env)
# ์˜ˆ์‹œ: .env.dev ๋˜๋Š” .env.prod ํŒŒ์ผ์„ ํ”„๋กœ์ ํŠธ ๋ฃจํŠธ์— ์ƒ์„ฑ

# 4. Docker Compose๋กœ ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰
docker-compose -f docker-compose.dev.yml up --build

๐Ÿš€ ๋ฐฐํฌ ๋งํฌ

FE (dev) https://localhost:3000/
BE (dev) https://localhost:5000/api-docs/
FE (prod) https://lostparty.com (๋น„์šฉ๋ฌธ์ œ๋กœ ์ผ์‹œ์ค‘์ง€)
BE (prod) ๋น„๊ณต๊ฐœ

๐Ÿ‘‹๐Ÿป ํŒ€์› ์†Œ๊ฐœ

ํŒ€์› ๋‹ด๋‹น ํ”„๋กœํ•„ ์ฃผ์š” ๊ธฐ์—ฌ ๋ฐ ํ•ต์‹ฌ ์—ญํ• 
๊น€๋„ํ™˜ Python โ€ข PaddleOCR๋ฅผ ํ™œ์šฉํ•œ ํ…์ŠคํŠธ ์ถ”์ถœ ๋กœ์ง ๊ตฌํ˜„
โ€ข ํ™”๋ฉด ๊ณต์œ  ๊ธฐ๋ฐ˜ OCR ํ”„๋กœ์„ธ์Šค ๊ฐœ๋ฐœ
โ€ข ํ”„๋ก ํŠธ์—”๋“œ OCR ์—ฐ๋™ ๊ตฌํ˜„
์ตœ์ข…ํ˜„ FrontEnd โ€ข ํ”„๋ก ํŠธ์—”๋“œ ์ „๋ฐ˜ ๊ฐœ๋ฐœ
โ€ข ํ”„๋ก ํŠธ์—”๋“œ UI/UX ๊ตฌํ˜„ ๋ฐ ์Šคํƒ€์ผ๋ง
๊น€์žฌ์ฐฌ BackEnd โ€ข ์‚ฌ์šฉ์ž ์ธ์ฆ ๋ฐ ๋ณด์•ˆ ๊ฐ•ํ™”๋ฅผ ์œ„ํ•œ ๋กœ๊ทธ์ธยท๋กœ๊ทธ์•„์›ƒ ๊ธฐ๋Šฅ ๊ตฌํ˜„ (์‹คํšจ์„ฑ ๊ฒ€ํ†  ํ›„ ๋ฏธ์ ์šฉ)
์„ฑ์ธ์„ BackEnd โ€ข Dockerfile ์ž‘์„ฑ ๋ฐ ๊ฐœ๋ฐœํ™˜๊ฒฝ ๊ตฌ์ถ•
โ€ข DB ๊ตฌ์กฐ ์„ค๊ณ„ ๋ฐ API ์—ฐ๋™
โ€ข API ๋ฐ ๊ธฐ๋Šฅ ๋ช…์„ธ์„œ ์ž‘์„ฑ
โ€ข ํŽ˜์ด์ง€ ๊ตฌ์„ฑ ์„ค๊ณ„ ๋ฐ OpenAPI๋ฅผ ํ™œ์šฉํ•œ ๋ฐ์ดํ„ฐ ์žฌ๊ฐ€๊ณต
โ€ข ํŒ€์› ๋ชจ์ง‘ ๋ฐ ํ”„๋กœ์ ํŠธ ๊ด€๋ฆฌ (๋…ธ์…˜ ์ •๋ฆฌ ํฌํ•จ)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •