node-skeleton
An nodejs boilerplate packaged with Typescript, Docker, Kubernetes, PM2, Eslint, Prettier, VSCode config, Winston, Typedoc, Nodemon, AVA, PromClient, JWT, Editorconfig, OpenAPI/Swagger, Jaeger/Open Tracing, etc.
파일 탐색기
최종 버전 다운로드 (.zip)- launch.json
- settings.json
- tasks.json
- jwtRS512.key
- jwtRS512.key.pub
- api.server.controller.js
- api.server.controller.js.map
- auth.server.controller.js
- auth.server.controller.js.map
- metrics.server.controller.js
- metrics.server.controller.js.map
- dbschema.js
- dbschema.js.map
- favicon.ico
- index.html
- api.server.routes.js
- api.server.routes.js.map
- root.server.routes.js
- root.server.routes.js.map
- api.utils.js
- api.utils.js.map
- auth.utils.js
- auth.utils.js.map
- error.utils.js
- error.utils.js.map
- main.utils.js
- main.utils.js.map
- tracing.utils.js
- tracing.utils.js.map
- 404.server.view.html
- index.server.view.html
- all.js
- all.js.map
- alpha.js
- alpha.js.map
- development.js
- development.js.map
- production.js
- production.js.map
- secure.js
- secure.js.map
- local.js
- config.js
- config.js.map
- express.js
- express.js.map
- init.js
- init.js.map
- logger.js
- logger.js.map
- schema.js
- schema.js.map
- test.js
- test.js.map
- server.js
- server.js.map
- main.css
- icons.png
- icons@2x.png
- widgets.png
- widgets@2x.png
- main.js
- search.js
- _app_controllers_api_server_controller_.html
- _app_controllers_auth_server_controller_.html
- _app_controllers_metrics_server_controller_.html
- _app_db_schema_dbschema_.html
- _app_routes_api_server_routes_.html
- _app_routes_root_server_routes_.html
- _app_utils_api_utils_.html
- _app_utils_auth_utils_.html
- _app_utils_error_utils_.html
- _app_utils_main_utils_.html
- _app_utils_tracing_utils_.html
- _config_config_.html
- _config_env_all_.html
- _config_env_alpha_.html
- _config_env_development_.html
- _config_env_production_.html
- _config_env_secure_.html
- _config_express_.html
- _config_init_.html
- _schema_schema_.html
- _server_.html
- globals.html
- index.html
- deployment.yml
- service.yml
- README.md
- api.server.controller.ts
- auth.server.controller.ts
- metrics.server.controller.ts
- dbschema.ts
- favicon.ico
- index.html
- api.server.routes.ts
- root.server.routes.ts
- api.utils.ts
- auth.utils.ts
- error.utils.ts
- main.utils.ts
- tracing.utils.ts
- 404.server.view.html
- index.server.view.html
- local.js
- config.ts
- express.ts
- schema.ts
- test.ts
- interfaces.d.ts
- server.ts
- .dockerignore
- .editorconfig
- .env
- .eslintignore
- .eslintrc
- .gitignore
- .prettierignore
- .prettierrc
- .travis.yml
- apidoc.yaml
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- CONTRIBUTORS.txt
- docker-compose-prod.yml
- docker-compose.yml
- Dockerfile
- Dockerfile-prod
- LICENSE
- Makefile
- nodemon.json
- package-lock.json
- package.json
- pm2-dev.json
- README.md
- tsconfig.json
- typedoc.js
# 설치 가이드
1. 코드 내려받기
git clone https://github.com/tvvignesh/node-skeleton
깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.
cd node-skeleton
방금 내려받은 프로젝트 폴더 안으로 이동합니다.
2. Docker
쉬움 추천사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker compose up -d --build
정의된 모든 컨테이너(서버, DB 등)를 한 번에 빌드하고 백그라운드에서 실행합니다.
터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.
3. Node.js
쉬움사전 준비물
npm install
package.json에 명시된 라이브러리들을 내려받아 설치합니다.
npm start
개발/실행 서버를 켭니다.
명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.
4. Make
보통사전 준비물
- Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
- Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.
make
생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.
에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.
// repository documentation
Was this content helpful?
(0 ratings)