Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

스켈레톤 프로젝트 초기 설정 #1

Closed
13 of 14 tasks
Zamoca42 opened this issue Oct 25, 2023 · 6 comments
Closed
13 of 14 tasks

스켈레톤 프로젝트 초기 설정 #1

Zamoca42 opened this issue Oct 25, 2023 · 6 comments
Assignees
@Zamoca42
Labels
chore 설정 및 기타 관련 docs 문서 작성 관련 infra 인프라 관련

Comments

@Zamoca42
Copy link
Member

Zamoca42 commented Oct 25, 2023 •
edited
Loading

초기설정에서 필요한 사항에 대해 코멘트 부탁드립니다!
@Zamoca42 Zamoca42 added docs 문서 작성 관련 chore 설정 및 기타 관련 infra 인프라 관련 labels Oct 25, 2023
@Zamoca42 Zamoca42 assigned hojoonSong and Zamoca42 and unassigned hojoonSong and Zamoca42 Oct 25, 2023
@Zamoca42 Zamoca42 pinned this issue Oct 25, 2023
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Chore: NestJS 프로젝트 시작
61778d4 
- `nest new ./` 명령어를 사용하여 NestJS 프로젝트 초기 설정을 적용

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Docs: 템플릿 추가
0224ce0 
- 일관성 있는 협업을 위해 PR/버그/이슈/커밋 템플릿 추가
Related to #1
@Zamoca42 Zamoca42 mentioned this issue Oct 25, 2023
Merged
14 tasks
@myeongseoklee
Copy link

myeongseoklee commented Oct 25, 2023 •
edited
Loading

생각해본 부분은 아래와 같습니다. 어떻게 생각하시나요??!

  1. morgan 미들웨어 추가
  2. cors 미들웨어 추가
  3. env별로 config 설정(@nest/config)하거나 logging(winston)을 따로 처리할 지 논의해봐야 할 것 같아요.

Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Chore: 도커, 도커 컴포즈 설정 추가
a993b2a 
- 개발환경을 일관되게 설정할 수 있도록 도커 컨테이너 설정 적용

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Chore: 패키지 적용
3104d7f 
- dto에서 검증, 변환 작업을 위해 class-vt,tf 패키지 적용
- api 문서화 작업을 위해 swagger 패키지 적용

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Ci: GitHub-Actions CI 설정 적용
302a71e 
- PR시 포맷팅, 테스트, 린트가 통과했는지 확인하기 위해 CI 설정 적용

Related to #1
@Zamoca42
Copy link
Member Author

Zamoca42 commented Oct 25, 2023 •
edited
Loading

생각해본 부분은 아래와 같습니다. 어떻게 생각하시나요??!

  1. morgan 미들웨어 추가
  2. cors 미들웨어 추가
  3. env별로 config 설정(@nest/config)하거나 logging(winston)을 따로 처리할 지 논의해봐야 할 것 같아요.

morgan과 winston은 어떤 차이가 있나요? 둘 다 로깅 라이브러리가 맞나요?
우선은 global exception filters에서 logger로 간단하게 로깅 처리를 하고 로깅을 따로 처리할지 논의해보는게 좋을거 같습니다.

env도 @nest/config를 사용하는게 좋다고 저는 생각하는데 다른분들 의견은 어떤지 궁금하네요.
다른 방법으로는 dotenv 라이브러리를 사용하는게 있을거같습니다.

저도 cors는 미들웨어에서 설정해주는게 간편해서 선호하고있습니다

@myeongseoklee
Copy link

생각해본 부분은 아래와 같습니다. 어떻게 생각하시나요??!

  1. morgan 미들웨어 추가
  2. cors 미들웨어 추가
  3. env별로 config 설정(@nest/config)하거나 logging(winston)을 따로 처리할 지 논의해봐야 할 것 같아요.

morgan과 winston은 어떤 차이가 있나요? 둘 다 로깅 라이브러리가 맞나요? 우선은 global exception filters에서 logger로 간단하게 로깅 처리를 하고 로깅을 따로 처리할지 논의해보는게 좋을거 같습니다.

env도 @nest/config를 사용하는게 좋다고 저는 생각하는데 다른분들 의견은 어떤지 궁금하네요. 다른 방법으로는 dotenv 라이브러리를 사용하는게 있을거같습니다.

저도 cors는 미들웨어에서 설정해주는게 간편해서 선호하고있습니다

morgan은 http req/res 관련 로깅에 사용했었고
winston은 내부 코드 동작 로깅에 사용했었습니다!

@myeongseoklee
Copy link

myeongseoklee commented Oct 25, 2023 •
edited
Loading

README 템플릿도 추가해두면 어떨까요~?

다음과 같은 내용을 포함하면 좋다고 합니다.

  • 간단한 소개 1~2줄(메인 페이지 이미지 1장)
  • 아키텍처(이미지 1장): 어떤 식으로 배포가 되어있는지
  • 주요 라이브러리 소개 5개
  • 프로젝트 배포링크
  • REST API 문서 링크
  • 주요 기능 소개(이미지는 최소화, 읽을 때 피로감을 준다. 복잡한 기능을 소개 한다면, 최대 3개까지만 넣기)
  • 개발 주요 로드맵(체크리스트)
    • 개발해온 내역
    • 프로젝트를 쭉 이어나가고 있다면 앞으로 어떤 개발이 남아있는지를 작성
  • Author
  • License
  • FAQ
  • Contribute: 코드 기여를 받을거라면 하는 방법, 어떻게 받을지 안내
  • Contact

ex) https://github.com/othneildrew/Best-README-Template/blob/master/README.md

@Zamoca42
Copy link
Member Author

@myeongseoklee 오 README에 뭘 적을지 고민중이였는데 의견 감사합니다! 추가해보겠습니다.

프로젝트 배포링크는 어떤걸까요?

@myeongseoklee
Copy link

@myeongseoklee 오 README에 뭘 적을지 고민중이였는데 의견 감사합니다! 추가해보겠습니다.

프로젝트 배포링크는 어떤걸까요?

앞단 화면을 구현해서 배포한 경우에 넣는 링크입니다. 저희는 앞단 구현이 있을지 없을지 모르니 빼도 될 것 같아요.

Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Chore: 환경변수 컨트롤 및 검증 설정 적용 #1
e9b6229 
- 일관성 있는 개발환경을 위해서 환경변수 컨트롤하고 검증하는 미들웨어를 설정

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Feat: global exception filter 적용 #1
7128d5c 
- 서비스 로직에서 간단한 예외처리를 위해 전역 예외 필터 설정 적용

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Chore: 필요 없는 환경변수 검증 제거 #1
9d11381 
Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Chore: swagger 설정 적용 #1
c41f706 
- api 문서화를 위해서 swagger 설정 적용

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Docs: 개발 문서 변경
1a2c287 
- 스켈레톤 프로젝트를 사용해보기 위한 실행 방법 적용 (임시)

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Chore: 개발 환경을 제외하고 예시 환경 추가
1dcacd7 
- 개발 서버가 필요 없기 때문에 development 환경 제외
- env.example을 추가해서 환경 변수 예시에 대해 명시

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Chore: 패키지 설치 명령 수정
9a9586b 
- 같은 패키지 버전을 맞추기 위해 npm install -> ci로 변경

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Refactor: 예외 필터 수정
f15aec3 
- 예외 필터 일반화를 위해 BadRequest(400) 에러만 따로 처리하던 경우 제외

Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Feat: 응답객체 직렬화 추가
ee3831f 
- 응답객체 직렬화를 위한 글로벌 인터셉터 추가

- Related to #1
Zamoca42 added a commit that referenced this issue Oct 25, 2023
@Zamoca42
Docs: 로컬 환경 실행 명령 제외
9f07d04 
- 로컬 환경 실행을 제외하고 노드 버전을 통일하기 위해 도커 실행만 명시

Related to #1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Zamoca42 Zamoca42

Labels
chore 설정 및 기타 관련 docs 문서 작성 관련 infra 인프라 관련
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hojoonSong @Zamoca42 @myeongseoklee