SOPKATHON-SERVER

service

---

• 서비스 이름: 참참참
• 소개 : 참을 인 세번이면, 텅장을 면한다. 소비습관을 개선하기 위해 시각화하여 절약을 유도한다.

🔔 서비스 가치제안 : 소비습관을 개선하고 싶을 때 사용할 수 있는 서비스 순간의 소비를 참는 행위를 통해 돈을 벌었다는 생각의 변화를 주어 절약을 유도한다.

🔔 서비스 문제정의 : 소비자는 절약하는 소비습관을 들이고 싶고, 순간의 욕구를 참을 수 있는 서비스를 원한다.

🔔 서비스 타겟정의 : 소비의 욕구에서 벗어나고 싶어하지만 의지와 동기부여가 부족한, 20대 대학생 여성

각자 개발 담당 부분

---

• 현정 : 홈 조회, 리스트 팝업창 조회
• 다현 : 상품 리스트 조회
• 수린 : 작성하기

1. Foldering

---

.
├── tsconfig.json
├── nodemone.json
├── package.json
├── .gitignore
├── .env
├── yarn.lock
├── prisma
├── node_modules
└── src
    ├── controller
    ├── service
    ├── router
    ├── constants
    └── index.ts 

Git convention

---

✔️ Commit Convention

• ✅ [CHORE] : 동작에 영향 없는 코드 or 변경 없는 변경사항(주석 추가 등)
• ✨ [FEAT] : 새로운 기능 구현
• ➕ [ADD] : Feat 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 파일 생성
• 🔨 [FIX] : 버그, 오류 해결
• ⚰️ [DEL] : 쓸모없는 코드 삭제
• 📝 [DOCS] : README나 WIKI 등의 문서 수정
• ✏️ [CORRECT] : 주로 문법의 오류나 타입의 변경, 이름 변경시
• ⏪️ [RENAME] : 파일 이름 변경시
• ♻️ [REFACTOR] : 전면 수정
• 🔀 [MERGE]: 다른 브랜치와 병합

ex) commit -m "[FEAT] user API 구현"

✔️ Branch Convention

• [feat] : 기능 추가
• [fix] : 에러 수정, 버그 수정
• [docs] : README, 문서
• [refactor] : 코드 리펙토링 (기능 변경 없이 코드만 수정할 때)
• [modify] : 코드 수정 (기능의 변화가 있을 때)
• [chore] : gradle 세팅, 위의 것 이외에 거의 모든 것

ex) feat-user-api

브랜치 전략

• main : 메인 브랜치
• main에 직접적인 commit, push는 가급적 금지합니다
• 작업 전, 반드시 main 브랜치를 pull 받고 시작합니다 git pull origin main
• 기능 개발 시 feature/기능 브랜치를 파서 관리합니다 git branch feature/기능
• 작은 기능별로 commit message rules에 따라 커밋을 진행합니다
• 작업 완료 시 main 브랜치로 Pull Request를 보냅니다
• 팀원과 코드리뷰를 진행한 후, 최종적으로 main 브랜치로 merge합니다
• 다 쓴 브랜치는 삭제합니다

✔️ Code Convention

---

https://jade-savory-505.notion.site/Code-Convention-d4a469f20a184c88b1e46e4262f8adbd

API DOCS

---

API 명세서 링크: https://jade-savory-505.notion.site/API-Docs-6b7e59da93424d5a9aac4a7ebd4e83fa

ERD

---

---

schema.prisma

---

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

model Product {
  id          Int     @id @default(autoincrement())
  productName String  @db.VarChar(200)
  price       Int
  contents    String?
  userId      Int
  User        User    @relation(fields: [userId], references: [id], onDelete: Cascade, map: "product_user_id_fk")
  Time        Time[]
}

model User {
  id      Int       @id @default(autoincrement())
  name    String    @unique @db.VarChar(50)
  Product Product[]
}

model Time {
  id        Int     @id @default(autoincrement())
  productId Int
  year      String  @db.VarChar(10)
  month     String  @db.VarChar(10)
  day       String  @db.VarChar(10)
  time      String  @db.VarChar(30)
  Product   Product @relation(fields: [productId], references: [id], onDelete: Cascade, map: "time_product_id_fk")
}

Package.json

---

{
  "name": "sopkathon",
  "version": "1.0.0",
  "main": "index.js",
  "repository": "https://github.com/SOPT-31th-SOPKATHON-15/SOPKATHON-SERVER.git",
  "author": "hyeonjeong Park <[email protected]>",
  "license": "MIT",
  "scripts": {
    "dev": "nodemon",
    "build": "tsc && node dist",
    "db:pull": "npx prisma db pull",
    "db:push": "npx prisma db push",
    "generate": "npx prisma generate"
  },
  "dependencies": {
    "@prisma/client": "^4.6.1",
    "express": "^4.18.2",
    "prisma": "^4.6.1"
  },
  "devDependencies": {
    "@types/express": "^4.17.14",
    "@types/node": "^18.11.9",
    "nodemon": "^2.0.20"
  }
}

server architecture

---