README.md

Project : DoWith-backend

Team : IIW - It Works Why

Front End: https://github.com/tomoyo519/DoWith_frontend

🗂️ 목차

💁 멤버

📆 기간

📬 프로젝트-개요

📌 디렉토리 구조

📍 기능

🔧 기술 스택

💏 협업

📈 기술적 이슈

업무 상세 내용

💁 ‍멤버

Github
이름	이인복	신병철	박세준	이소정	정다희
포지션
gmail	bbock1214	qudcjf153	psjbrian	sojeong.lee017	vanessa.cheong1
블로그
업무	무엇 했는지

📆 기간

• 설계: 2023.11.07 ~ 2023.11.14 (1주)
  • PPT: 바로가기
• 개발: 2023.11.14 ~ 2023.12.07 (약 3주)
• 테스트: 2023.12.07 ~ 2023.12.16 (약 1주)
• 시연: 2023.12.16(토)
  • 포스터:

📬 프로젝트 개요

ios 미리알림이나 마이크로소프트 투두 등 시중에는 많은 투두앱이 있습니다. 하지만 끈기있게 사용하기가 어렵습니다. 왜 그럴까요?

유저들은 귀찮아서, 혹은 의욕을 잃어서, 알림을 무시하게 되서 등의 이유로 투두 앱을 쓰지 않게 되었습니다.

우리는 동기부여가 부족해서 목표를 달성하지 못하고 이탈해버리는 사람을 핵심 타겟 으로 설정하였습니다.

📌 디렉토리 구조

   ├ 📦 package
   ⎮    ├ 📁 env   : 개발 / 테스트 / 운영 환경변수
   ⎮    ├ 📁 public: 정적 리소스
   ⎮    ├ 📁 logs  : 로그 파일(ignore)
   ⎮    ├ 📁 src   : 소스 코드
   ⎮    ⎮    ├ 📁 auth
   ⎮    ⎮    ├ 📁 entities
   ⎮    ⎮    ⎮    ├ 📄 {Entitiy Name}.entity.ts
   ⎮    ⎮    ⎮    ├ 📄 entities.module.ts
   ⎮    ⎮    ├ 📁 enums
   ⎮    ⎮    ⎮    ├ 📄 {Enum Name}.enum.ts
   ⎮    ⎮    ├ 📁 features
   ⎮    ⎮    ⎮    ├ 📁 {API Name}.enum.ts
   ⎮    ⎮    ⎮    ⎮    ├ 📁 dto
   ⎮    ⎮    ⎮    ⎮    ⎮    ├ 📄 {DTO name}.dto.ts
   ⎮    ⎮    ⎮    ⎮    ├ 📄 {API Name}.controller.ts
   ⎮    ⎮    ⎮    ⎮    ├ 📄 {API Name}.service.ts
   ⎮    ⎮    ⎮    ⎮    ├ 📄 {API Name}.module.ts
   ⎮    ⎮    ├ 📁 firebase
   ⎮    ⎮    ├ 📁 gateway
   ⎮    ⎮    ├ 📁 utils
   ⎮    ⎮    ⎮    ├ 📄 exception.filter.ts
   ⎮    ⎮    ⎮    ├ 📄 exception.ts
   ⎮    ⎮    ⎮    ├ 📄 Interceptor.ts
   ⎮    ⎮    ⎮    ├ 📄 middleware.middleware.ts
   ⎮    ⎮    ⎮    ├ 📄 MulterConfigService.ts
   ⎮    ⎮    ⎮    ├ 📄 PagingOptions.ts
   ⎮    ⎮    ├ 📄 app.gateway.ts
   ⎮    ⎮    ├ 📄 app.module.ts
   ⎮    ⎮    ├ 📄 main.ts
   ├ 📝 README.md

📍 기능

기능 or API 목록 들어가면 될듯

🔧 기술 스택

분야	기술
Front
Back
DB
Lib
DevOps

여기에다가 기술 아키텍쳐 사진 넣을것

💏 협업

바로가기	설명
	형상, 이슈 관리 & 코드 리뷰
	타임라인기반 일정 관리
	스크럼, API Docs, 메타데이터, 피드백, 회의록 등
	화면 설계
	DB ERD
	파일 공유
	의사소통

📈 기술적 이슈

1. 화면 렌더링

2. 메모리 누수 & 데드락

• 메모리 누수 (Memory Leak): https://nashs789.tistory.com/106
• 데드락 (Deadlock): https://nashs789.tistory.com/107

업무 상세 내용

• 인복
  • API
  • 서버 레이어 구축
  • 서버 공통 모듈 및 기능 모듈화
• 병철
  • CI & CD
  • 자동 배포 환경
  • 마이룸
• 세준
  • 알림 & 히스토리
  • 인벤토리
  • 친구
• 소정
  • Oauth & JWT 토큰 인증
  • 인앱 이벤트
• 다희
  • 개인 할일
  • 그룹 할일
  • 마이 페이지
  • 상점

⚙️ 환경 설정

# Postgres
DB_HOST=
DB_PORT=
DB_USERNAME=
DB_PASSWORD=
DB_DATABASE=

# NestJS
PORT=
LOG_LEVEL=
LOG_PATH=
IMAGE_PATH=
PUBLIC_IMAGE_PATH=

# Kakao Oauth
SERVER=
KAKAO_REST_API_KEY=
APP_SCHEME=
KAKAO_URL=

# JWT
JWT_SECRET=