Skip to content

Commit 5d642af

Browse files
committed
chore: README.md 정리
1 parent 7d3e019 commit 5d642af

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
## Description
2+
3+
nodejs express 이용한 보일러 플레이트
4+
5+
## Installation
6+
7+
```bash
8+
$ npm install
9+
```
10+
11+
## Running the app
12+
13+
환경 설정 파일을 build 한 경로 내부에 설정해야함
14+
`/config` 경로에 아래 파일을 생성한다.
15+
.<NODE_ENV환경변수값>.env
16+
설정 내용은 다음과 같다.
17+
18+
```dotnetcli
19+
HOST=<호스트주소>
20+
PORT=<서버포트>
21+
```
22+
23+
- 위 설정을 사용은 config 이용하여 처리함
24+
25+
## 실행법
26+
27+
```bash
28+
$ npm start
29+
30+
```
31+
32+
## docker - 작업중
33+
```bash
34+
# docker build
35+
$ docker build -t <docker-image-name:tag> .
36+
37+
# docker run
38+
$ docker run <docker-image-name:tag>
39+
```
40+
41+
## Test
42+
43+
```bash
44+
# unit tests
45+
$ npm run test
46+
47+
# e2e tests
48+
$ npm run test:e2e
49+
50+
# test coverage
51+
$ npm run test:cov
52+
```
53+
54+
## Stay in touch
55+
56+
- Author - 김진황

0 commit comments

Comments
 (0)