Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zerosial authored Feb 20, 2024
1 parent 5b1d7f4 commit b3ea2b4
Showing 1 changed file with 90 additions and 2 deletions.
92 changes: 90 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,94 @@
# 소개
### **프로젝트 명**: 파인 마켓 (당근마켓 클론)

![chrome_61HkvTxx4T](https://github.com/zerosial/Pinemarket_React_Frontend/assets/97251710/140f5219-d450-4026-800a-59db3acde328)

WEB: https://pinemarket.cielui.com/web
API_END_POINT: https://pinemarket.cielui.com
SWAGGER: https://pinemarket.cielui.com/docs



### 1. 서론

**팀 소개 및 프로젝트 개요**

- 팀원: 유진(프론트엔드), 낙준(프론트엔드), 승훈(풀스택)
- 프로젝트 목적: 기술 습득 및 향상을 위한 미니 프로젝트
- 동기: 당근마켓의 유저 인터페이스와 기능을 모델로 삼아, 현대적인 기술 스택을 활용하여 유사한 서비스를 제작

**프로젝트 선정 배경**

- UI의 단순함과 더불어 구현 목표였던 기능이 다수 존재
- 최신 프론트엔드 기술을 활용한 실제 프로젝트 경험 축적

### 2. 프로젝트 관리 및 협업 방법

**코드 리뷰 및 회의 스케줄**

- 코드 리뷰: 매주 월, 수, 금 오후 3시 PR 리뷰 및 머지
- 주간 회의: 매주 한 번, 시간 미정 (주로 수요일에 진행)

**Branch 및 Commit 규칙**

- Branch 명명 규칙: **`feature/[기능명]`**
- Commit 메시지 규칙: **`feat: [기능 설명]`** (한글 사용 가능)

### 3. 기술 스택 및 도구

**기술 스택 소개**
- 백엔드

# 코어

### Nest.js

- **장점**: Angular와 유사한 구조를 가진 Node.js 프레임워크로, 타입스크립트 지원, 효율적인 코드 조직, 모듈화 촉진.
- **적용법**: 모듈, 컨트롤러, 서비스를 사용하여 RESTful API를 구성하고, 의존성 주입을 활용하여 유연성 및 테스트 용이성 제공.

### Prisma

- **장점**: 타입스크립트 지원 ORM, 간편한 데이터베이스 스키마 마이그레이션 및 쿼리 구성.
- **적용법**: **`schema.prisma`** 파일에서 데이터 모델을 정의하고, Prisma 클라이언트를 사용하여 데이터베이스와의 상호 작용을 쉽게 함.

# DB

### PostgreSQL

- **장점**: 강력한 오픈 소스 객체 관계형 데이터베이스 시스템, 복잡한 쿼리, 대용량 데이터 처리에 적합.
- **적용법**: 데이터 저장, 검색, 관리를 위해 Prisma와 함께 사용하여 데이터 무결성 및 보안 유지.

# 문서

### Swagger

- **장점**: API 설계, 빌드, 문서화, 테스트를 위한 오픈 소스 프레임워크. 사용자 친화적인 문서 자동 생성.
- **적용법**: Nest.js 프로젝트에 Swagger 모듈을 통합하여 API 엔드포인트에 대한 문서를 자동으로 생성하고 관리.

# 배포

### Docker

- **장점**: 애플리케이션을 컨테이너화하여 환경에 구애받지 않는 일관된 개발, 배포, 실행을 가능하게 함.
- **적용법**: 개발 환경을 Docker 컨테이너로 구성하고, Docker Compose를 사용하여 멀티 컨테이너 애플리케이션을 관리.
- 선택 이유: 습득해보고 싶은 기술들과 사용해보고 싶은 기술 중심으로 선정

### 4. 프로젝트 주요 기능 및 개발 과정 (각 개발자)

**유진**

- 담당 기능: 메인 페이지와 검색 기능
- 개발 과정: 사용자 경험 중심의 디자인 및 캐싱 전략 구현, 재사용있는 컴포넌트 구현

**승훈**

- 담당 기능: 로그인/로그아웃, 헤더 및 푸터, 프로필 페이지, 백엔드 전반
- 개발 과정: 보안 강화 및 사용자 인터페이스 일관성 유지

**낙준**

- 담당 기능: 모달, 라우트 설정, 상세 페이지
- 개발 과정: 높은 퍼포먼스 유지를 위한 최적화 전략 구현

Nest.JS 학습을 위한 Repo (GraphQL , Rest API, Prisma, PostgreSQL, Login (w passport, jwt etc)

## Features

Expand Down

0 comments on commit b3ea2b4

Please sign in to comment.