parent
f571d32d60
commit
c88bba304d
@ -0,0 +1,9 @@ |
||||
services: |
||||
api: |
||||
build: |
||||
context: app |
||||
target: dev-envs |
||||
ports: |
||||
- 3000:3000 |
||||
volumes: |
||||
- /var/run/docker.sock:/var/run/docker.sock |
@ -0,0 +1,64 @@ |
||||
## Compose sample application |
||||
|
||||
### Use with Docker Development Environments |
||||
|
||||
### NestJS |
||||
|
||||
Project structure: |
||||
|
||||
``` |
||||
. |
||||
├── compose.yaml |
||||
├── README.md |
||||
└── app |
||||
├── Dockerfile |
||||
└── ... |
||||
``` |
||||
|
||||
[_compose.yaml_](compose.yaml) |
||||
|
||||
``` |
||||
services: |
||||
api: |
||||
build: |
||||
context: app |
||||
target: production |
||||
ports: # You should add the port you need to expose applicaiton if you change the default port |
||||
- '3000:3000' |
||||
``` |
||||
|
||||
Make sure port 3000 on the host is not already being in use. |
||||
Make sure you have already add the port you need to expose applicaiton if you change the default port |
||||
|
||||
## Deploy with docker compose |
||||
|
||||
``` |
||||
$ docker compose up -d |
||||
[+] Building 1.2s (18/19) |
||||
=> [internal] load build definition from Dockerfile |
||||
=> transferring dockerfile: 655B |
||||
... |
||||
[+] Running 1/1 |
||||
⠿ Container nestjs-api-1 Started |
||||
``` |
||||
|
||||
## Expected result |
||||
|
||||
Listing containers must show one container running and the port mapping as below: |
||||
|
||||
``` |
||||
$ docker ps |
||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES |
||||
7573c6f216ed nestjs_api "docker-entrypoint.s…" 2 minutes ago Up 2 minutes (health: starting) 0.0.0.0:3000->3000/tcp, :::3000->3000/tcp nestjs-api-1 |
||||
``` |
||||
|
||||
After the application starts, navigate to `http://localhost:3000` in your web browser. (if you didn't specify a port, the default port will be used.) |
||||
|
||||
Stop and remove the containers |
||||
|
||||
``` |
||||
$ docker compose down |
||||
[+] Running 2/2 |
||||
⠿ Container nestjs-api-1 Removed |
||||
⠿ Network nestjs_default Removed |
||||
``` |
@ -0,0 +1 @@ |
||||
node_modules/ |
@ -0,0 +1,25 @@ |
||||
module.exports = { |
||||
parser: '@typescript-eslint/parser', |
||||
parserOptions: { |
||||
project: 'tsconfig.json', |
||||
tsconfigRootDir : __dirname,
|
||||
sourceType: 'module', |
||||
}, |
||||
plugins: ['@typescript-eslint/eslint-plugin'], |
||||
extends: [ |
||||
'plugin:@typescript-eslint/recommended', |
||||
'plugin:prettier/recommended', |
||||
], |
||||
root: true, |
||||
env: { |
||||
node: true, |
||||
jest: true, |
||||
}, |
||||
ignorePatterns: ['.eslintrc.js'], |
||||
rules: { |
||||
'@typescript-eslint/interface-name-prefix': 'off', |
||||
'@typescript-eslint/explicit-function-return-type': 'off', |
||||
'@typescript-eslint/explicit-module-boundary-types': 'off', |
||||
'@typescript-eslint/no-explicit-any': 'off', |
||||
}, |
||||
}; |
@ -0,0 +1,35 @@ |
||||
# compiled output |
||||
/dist |
||||
/node_modules |
||||
|
||||
# Logs |
||||
logs |
||||
*.log |
||||
npm-debug.log* |
||||
pnpm-debug.log* |
||||
yarn-debug.log* |
||||
yarn-error.log* |
||||
lerna-debug.log* |
||||
|
||||
# OS |
||||
.DS_Store |
||||
|
||||
# Tests |
||||
/coverage |
||||
/.nyc_output |
||||
|
||||
# IDEs and editors |
||||
/.idea |
||||
.project |
||||
.classpath |
||||
.c9/ |
||||
*.launch |
||||
.settings/ |
||||
*.sublime-workspace |
||||
|
||||
# IDE - VSCode |
||||
.vscode/* |
||||
!.vscode/settings.json |
||||
!.vscode/tasks.json |
||||
!.vscode/launch.json |
||||
!.vscode/extensions.json |
@ -0,0 +1,4 @@ |
||||
{ |
||||
"singleQuote": true, |
||||
"trailingComma": "all" |
||||
} |
@ -0,0 +1,41 @@ |
||||
# syntax=docker/dockerfile:1.4 |
||||
|
||||
FROM node:18.10 AS builder |
||||
|
||||
ARG NODE_ENV=development |
||||
ENV NODE_ENV=${NODE_ENV} |
||||
|
||||
WORKDIR /app |
||||
|
||||
COPY package*.json ./ |
||||
|
||||
RUN npm install glob rimraf |
||||
|
||||
RUN npm install --only=development |
||||
|
||||
COPY . . |
||||
|
||||
RUN npm run build |
||||
|
||||
FROM node:18.10 as production |
||||
|
||||
ARG NODE_ENV=production |
||||
ENV NODE_ENV=${NODE_ENV} |
||||
|
||||
ARG PORT=3000 |
||||
ENV PORT=${PORT} |
||||
|
||||
WORKDIR /app |
||||
|
||||
COPY package*.json ./ |
||||
|
||||
RUN npm install --only=production |
||||
|
||||
COPY . . |
||||
|
||||
COPY --from=builder /app/dist ./dist |
||||
|
||||
HEALTHCHECK --start-period=5s --interval=5m --timeout=2s \ |
||||
CMD curl -f http://localhost/${PORT} || exit 1 |
||||
|
||||
CMD ["npm", "run", "start:prod"] |
@ -0,0 +1,73 @@ |
||||
<p align="center"> |
||||
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a> |
||||
</p> |
||||
|
||||
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 |
||||
[circleci-url]: https://circleci.com/gh/nestjs/nest |
||||
|
||||
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> |
||||
<p align="center"> |
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> |
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> |
||||
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> |
||||
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> |
||||
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> |
||||
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> |
||||
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> |
||||
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> |
||||
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a> |
||||
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> |
||||
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a> |
||||
</p> |
||||
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer) |
||||
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)--> |
||||
|
||||
## Description |
||||
|
||||
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. |
||||
|
||||
## Installation |
||||
|
||||
```bash |
||||
$ npm install |
||||
``` |
||||
|
||||
## Running the app |
||||
|
||||
```bash |
||||
# development |
||||
$ npm run start |
||||
|
||||
# watch mode |
||||
$ npm run start:dev |
||||
|
||||
# production mode |
||||
$ npm run start:prod |
||||
``` |
||||
|
||||
## Test |
||||
|
||||
```bash |
||||
# unit tests |
||||
$ npm run test |
||||
|
||||
# e2e tests |
||||
$ npm run test:e2e |
||||
|
||||
# test coverage |
||||
$ npm run test:cov |
||||
``` |
||||
|
||||
## Support |
||||
|
||||
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). |
||||
|
||||
## Stay in touch |
||||
|
||||
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) |
||||
- Website - [https://nestjs.com](https://nestjs.com/) |
||||
- Twitter - [@nestframework](https://twitter.com/nestframework) |
||||
|
||||
## License |
||||
|
||||
Nest is [MIT licensed](LICENSE). |
@ -0,0 +1,5 @@ |
||||
{ |
||||
"$schema": "https://json.schemastore.org/nest-cli", |
||||
"collection": "@nestjs/schematics", |
||||
"sourceRoot": "src" |
||||
} |
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,74 @@ |
||||
{ |
||||
"name": "app", |
||||
"version": "0.0.1", |
||||
"description": "", |
||||
"author": "", |
||||
"private": true, |
||||
"license": "UNLICENSED", |
||||
"scripts": { |
||||
"prebuild": "rimraf dist", |
||||
"build": "nest build", |
||||
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"", |
||||
"start": "nest start", |
||||
"start:dev": "nest start --watch", |
||||
"start:debug": "nest start --debug --watch", |
||||
"start:prod": "node dist/main", |
||||
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix", |
||||
"test": "jest", |
||||
"test:watch": "jest --watch", |
||||
"test:cov": "jest --coverage", |
||||
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand", |
||||
"test:e2e": "jest --config ./test/jest-e2e.json" |
||||
}, |
||||
"dependencies": { |
||||
"@nestjs/axios": "^0.1.0", |
||||
"@nestjs/common": "^9.0.0", |
||||
"@nestjs/config": "^2.2.0", |
||||
"@nestjs/core": "^9.0.0", |
||||
"@nestjs/platform-express": "^9.0.0", |
||||
"@nestjs/terminus": "^9.1.2", |
||||
"reflect-metadata": "^0.1.13", |
||||
"rimraf": "^3.0.2", |
||||
"rxjs": "^7.2.0" |
||||
}, |
||||
"devDependencies": { |
||||
"@nestjs/cli": "^9.0.0", |
||||
"@nestjs/schematics": "^9.0.0", |
||||
"@nestjs/testing": "^9.0.0", |
||||
"@types/express": "^4.17.13", |
||||
"@types/jest": "28.1.8", |
||||
"@types/node": "^16.0.0", |
||||
"@types/supertest": "^2.0.11", |
||||
"@typescript-eslint/eslint-plugin": "^5.0.0", |
||||
"@typescript-eslint/parser": "^5.0.0", |
||||
"eslint": "^8.0.1", |
||||
"eslint-config-prettier": "^8.3.0", |
||||
"eslint-plugin-prettier": "^4.0.0", |
||||
"jest": "28.1.3", |
||||
"prettier": "^2.3.2", |
||||
"source-map-support": "^0.5.20", |
||||
"supertest": "^6.1.3", |
||||
"ts-jest": "28.0.8", |
||||
"ts-loader": "^9.2.3", |
||||
"ts-node": "^10.0.0", |
||||
"tsconfig-paths": "4.1.0", |
||||
"typescript": "^4.7.4" |
||||
}, |
||||
"jest": { |
||||
"moduleFileExtensions": [ |
||||
"js", |
||||
"json", |
||||
"ts" |
||||
], |
||||
"rootDir": "src", |
||||
"testRegex": ".*\\.spec\\.ts$", |
||||
"transform": { |
||||
"^.+\\.(t|j)s$": "ts-jest" |
||||
}, |
||||
"collectCoverageFrom": [ |
||||
"**/*.(t|j)s" |
||||
], |
||||
"coverageDirectory": "../coverage", |
||||
"testEnvironment": "node" |
||||
} |
||||
} |
@ -0,0 +1,22 @@ |
||||
import { Test, TestingModule } from '@nestjs/testing'; |
||||
import { AppController } from './app.controller'; |
||||
import { AppService } from './app.service'; |
||||
|
||||
describe('AppController', () => { |
||||
let appController: AppController; |
||||
|
||||
beforeEach(async () => { |
||||
const app: TestingModule = await Test.createTestingModule({ |
||||
controllers: [AppController], |
||||
providers: [AppService], |
||||
}).compile(); |
||||
|
||||
appController = app.get<AppController>(AppController); |
||||
}); |
||||
|
||||
describe('root', () => { |
||||
it('should return "Hello World!"', () => { |
||||
expect(appController.getHello()).toBe('Hello World!'); |
||||
}); |
||||
}); |
||||
}); |
@ -0,0 +1,12 @@ |
||||
import { Controller, Get } from '@nestjs/common'; |
||||
import { AppService } from './app.service'; |
||||
|
||||
@Controller() |
||||
export class AppController { |
||||
constructor(private readonly appService: AppService) {} |
||||
|
||||
@Get() |
||||
getHello(): string { |
||||
return this.appService.getHello(); |
||||
} |
||||
} |
@ -0,0 +1,12 @@ |
||||
import { Module } from '@nestjs/common'; |
||||
import { AppController } from './app.controller'; |
||||
import { AppService } from './app.service'; |
||||
import { HealthModule } from './health/health.module'; |
||||
import { ConfigModule } from '@nestjs/config'; |
||||
|
||||
@Module({ |
||||
imports: [HealthModule, ConfigModule.forRoot()], |
||||
controllers: [AppController], |
||||
providers: [AppService], |
||||
}) |
||||
export class AppModule {} |
@ -0,0 +1,8 @@ |
||||
import { Injectable } from '@nestjs/common'; |
||||
|
||||
@Injectable() |
||||
export class AppService { |
||||
getHello(): string { |
||||
return 'Hello World!'; |
||||
} |
||||
} |
@ -0,0 +1,3 @@ |
||||
export default () => ({ |
||||
port: parseInt(process.env.PORT, 10) || 3000, |
||||
}); |
@ -0,0 +1,22 @@ |
||||
import { Controller, Get } from '@nestjs/common'; |
||||
import { |
||||
HealthCheckService, |
||||
HttpHealthIndicator, |
||||
HealthCheck, |
||||
} from '@nestjs/terminus'; |
||||
|
||||
@Controller('health') |
||||
export class HealthController { |
||||
constructor( |
||||
private health: HealthCheckService, |
||||
private http: HttpHealthIndicator, |
||||
) {} |
||||
|
||||
@Get() |
||||
@HealthCheck() |
||||
check() { |
||||
return this.health.check([ |
||||
() => this.http.pingCheck('nestjs-docs', 'https://docs.nestjs.com'), |
||||
]); |
||||
} |
||||
} |
@ -0,0 +1,10 @@ |
||||
import { Module } from '@nestjs/common'; |
||||
import { TerminusModule } from '@nestjs/terminus'; |
||||
import { HttpModule } from '@nestjs/axios'; |
||||
import { HealthController } from './health.controller'; |
||||
|
||||
@Module({ |
||||
imports: [TerminusModule, HttpModule], |
||||
controllers: [HealthController], |
||||
}) |
||||
export class HealthModule {} |
@ -0,0 +1,14 @@ |
||||
import { NestFactory } from '@nestjs/core'; |
||||
import { AppModule } from './app.module'; |
||||
import configuration from './config/configuration'; |
||||
|
||||
async function bootstrap() { |
||||
const app = await NestFactory.create(AppModule); |
||||
|
||||
// Starts listening for shutdown hooks
|
||||
app.enableShutdownHooks(); |
||||
|
||||
await app.listen(configuration().port); |
||||
console.log(`Application is running on: ${await app.getUrl()}`); |
||||
} |
||||
bootstrap(); |
@ -0,0 +1,24 @@ |
||||
import { Test, TestingModule } from '@nestjs/testing'; |
||||
import { INestApplication } from '@nestjs/common'; |
||||
import * as request from 'supertest'; |
||||
import { AppModule } from './../src/app.module'; |
||||
|
||||
describe('AppController (e2e)', () => { |
||||
let app: INestApplication; |
||||
|
||||
beforeEach(async () => { |
||||
const moduleFixture: TestingModule = await Test.createTestingModule({ |
||||
imports: [AppModule], |
||||
}).compile(); |
||||
|
||||
app = moduleFixture.createNestApplication(); |
||||
await app.init(); |
||||
}); |
||||
|
||||
it('/ (GET)', () => { |
||||
return request(app.getHttpServer()) |
||||
.get('/') |
||||
.expect(200) |
||||
.expect('Hello World!'); |
||||
}); |
||||
}); |
@ -0,0 +1,9 @@ |
||||
{ |
||||
"moduleFileExtensions": ["js", "json", "ts"], |
||||
"rootDir": ".", |
||||
"testEnvironment": "node", |
||||
"testRegex": ".e2e-spec.ts$", |
||||
"transform": { |
||||
"^.+\\.(t|j)s$": "ts-jest" |
||||
} |
||||
} |
@ -0,0 +1,4 @@ |
||||
{ |
||||
"extends": "./tsconfig.json", |
||||
"exclude": ["node_modules", "test", "dist", "**/*spec.ts"] |
||||
} |
@ -0,0 +1,21 @@ |
||||
{ |
||||
"compilerOptions": { |
||||
"module": "commonjs", |
||||
"declaration": true, |
||||
"removeComments": true, |
||||
"emitDecoratorMetadata": true, |
||||
"experimentalDecorators": true, |
||||
"allowSyntheticDefaultImports": true, |
||||
"target": "es2017", |
||||
"sourceMap": true, |
||||
"outDir": "./dist", |
||||
"baseUrl": "./", |
||||
"incremental": true, |
||||
"skipLibCheck": true, |
||||
"strictNullChecks": false, |
||||
"noImplicitAny": false, |
||||
"strictBindCallApply": false, |
||||
"forceConsistentCasingInFileNames": false, |
||||
"noFallthroughCasesInSwitch": false |
||||
} |
||||
} |
@ -0,0 +1,7 @@ |
||||
services: |
||||
api: |
||||
build: |
||||
context: app |
||||
target: production |
||||
ports: # You should add the port you need to expose applicaiton if you change the default port |
||||
- '3000:3000' |
Loading…
Reference in new issue