Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jungnoh/nice-backend
a nice backend
https://github.com/jungnoh/nice-backend
architecture backend express
Last synced: about 15 hours ago
JSON representation
a nice backend
- Host: GitHub
- URL: https://github.com/jungnoh/nice-backend
- Owner: jungnoh
- Created: 2019-12-03T05:34:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T00:54:28.000Z (almost 2 years ago)
- Last Synced: 2024-04-20T00:15:18.790Z (7 months ago)
- Topics: architecture, backend, express
- Language: TypeScript
- Size: 567 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nice-backend
Node.JS 백엔드 프로젝트의 시작부터 배포까지 필요한 요소를 모두 담은 프로젝트 뼈대입니다.
# What's inside
- Mongodb with mongoose
- Basic passport.js implementation (`passport-local`)
- HTTPS support
- TSLint with pre-commit hooks
- Swagger, TSDoc documentations
- Minimal E2E testing with jest
- (todo) GraphQL querying
# 처음 시작하기
1. config 설정
다음과 같은 형태로 DB 접속정보를 설정하세요.
Development, production config는 각각 `config/config.dev.json`, `config/config.prod.json`에 저장됩니다.
```json
{
"mongodb": {
"url": "mongodb://localhost:27017/dev",
"user": "admin",
"pass": "123"
}
}
```
세션 키 (`sessionSecret`)는 설정하지 마십시오! 적절한 키 길이로 런타임에 설정됩니다.
# Notes
## HTTPS support
- HTTPS is only active in production mode (edit www.dev.ts to change this).
- Add your certificate (`server.key`, `server.crt`) under `./sslcert`
## REST structure
_[이미지 출처](https://www.coreycleary.me/project-structure-for-an-express-rest-api-when-there-is-no-standard-way/)_
### 1. 라우터 (/routes)
HTTP 요청을 받아 컨트롤러로 넘기기 전 유효성 확인, 권한 확인 수행
- 잘못된 요청이 들어올 경우 `400`, 권한이 없을 경우 `403` 반환
- Swagger 문서는 여기에 작성함
### 2. 컨트롤러 (/controllers)
HTTP 요청을 처리하는 단계
- `req`, `res`를 인자로 받아 적절한 결과 반환
- 서비스를 이용해 요청을 수행하고, JSON 형태로 결과를 보내는 역할
- **DB 작업은 컨트롤러에서 하지 않으며**, 데이터를 다루는 로직은 서비스에서 수행
### 3. 서비스 (/services)
실제 로직을 수행하는 단계
- 서비스는 HTTP `req`, `res`에 접근할 수 없음: 서버와 무관하게 동작해야 함
- 데이터베이스 접근은 이 단계에서 이루어짐
# 주요 라이브러리
프로젝트를 시작하기 전 이용방법을 숙지하시길 바립니다.
- [Mongoose](https://mongoosejs.com/) ⭐️
- [PassportJS](http://www.passportjs.org/) ⭐️
- [express-validator](https://express-validator.github.io/docs/): 요청 유효성 확인에 사용
# 관련 문서
- https://blog.wonhada.com/nginx-sslhttps-node-js/
- https://dev.to/rxassim/setup-postgresql-with-typeorm-in-graphql-tutorial-1cn8