DohwanKim / nest-be-father-gallery

Father Gallery

Nest.js로 개발한 Backend 프로젝트 입니다.

구현 된 기능

• 게시글을 위한 기본적인 CRUD 기능을 구현하였습니다.
  
  • 게시글 작성, 수정, 삭제, 조회 기능을 구현하였습니다.
    
  • 페이지네이션 기능과 검색 기능을 구현하였습니다.
    
• TypeORM을 이용하여 Postgres DB와 연동되고 있습니다.
  
• Cloudflare Image를 위한 API를 구현하였습니다.
  
• JWT를 이용하여 Access Token, Refresh Token를 이용하여 인증을 구현 하였습니다.
  
• Test의 경우 Unit Test는 Jest, E2E Test는 Supertest를 사용하여 작성되었습니다.
• Swagger를 이용하여 API 문서화를 구현하였습니다.

설명

아버지의 그림 작품들을 전시하는 사이트 위한 벡엔드 입니다.
차후 실제 서비스를 할 예정입니다.
현재는 개발을 위한 테스트용으로 사용하고 있습니다.
개인 프로젝트이지만 코드 작성의 맥락은 협업을 전제로 하여 작성하였습니다.
협업의 기준은 벡엔드 추가 인원 혹은 프론트엔드와 협업 시, 이 프로젝트의 맥락을 쉽게 이해하여 투입 될 수 있는가 입니다.

차후 진행할 작업

• 페이지네이션 구현
• Swagger를 이용한 API 문서화
• AWS Lightsail을 이용한 배포
• CI/CD 구축
  • CI: Github Actions
  • CD: AWS Lightsail
• (option) 차후 프론트엔드 작성 후 Mono Repo로 변경

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

API Documentation

If you want to see the Swagger API documentation, go to localhost:3000/api.

License

Nest is MIT licensed.