Skip to content

Commit ca270ab

Browse files
committed
add instructions in readme
1 parent e3557ad commit ca270ab

File tree

1 file changed

+19
-65
lines changed

1 file changed

+19
-65
lines changed

README.md

Lines changed: 19 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,29 @@
1-
<p align="center">
2-
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
3-
</p>
1+
# Content
2+
Dockerize the NestJS starter App.
43

5-
[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master
6-
[travis-url]: https://travis-ci.org/nestjs/nest
7-
[linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux
8-
[linux-url]: https://travis-ci.org/nestjs/nest
9-
10-
<p align="center">A progressive <a href="http://nodejs.org" target="blank">Node.js</a> framework for building efficient and scalable server-side applications, heavily inspired by <a href="https://angular.io" target="blank">Angular</a>.</p>
11-
<p align="center">
12-
<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
13-
<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
14-
<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/dm/@nestjs/core.svg" alt="NPM Downloads" /></a>
15-
<a href="https://travis-ci.org/nestjs/nest"><img src="https://api.travis-ci.org/nestjs/nest.svg?branch=master" alt="Travis" /></a>
16-
<a href="https://travis-ci.org/nestjs/nest"><img src="https://img.shields.io/travis/nestjs/nest/master.svg?label=linux" alt="Linux" /></a>
17-
<a href="https://coveralls.io/github/nestjs/nest?branch=master"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5" alt="Coverage" /></a>
18-
<a href="https://gitter.im/nestjs/nestjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge"><img src="https://badges.gitter.im/nestjs/nestjs.svg" alt="Gitter" /></a>
19-
<a href="https://opencollective.com/nest#backer"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
20-
<a href="https://opencollective.com/nest#sponsor"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
21-
<a href="https://paypal.me/kamilmysliwiec"><img src="https://img.shields.io/badge/Donate-PayPal-dc3d53.svg"/></a>
22-
<a href="https://twitter.com/nestframework"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
23-
</p>
24-
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
25-
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
4+
# You need
5+
- NPM
6+
- Node.js
7+
- NestJS
8+
- Docker
269

27-
## Description
10+
# Start Commands for Docker
11+
Build your image:
12+
`docker build <your path> -t <<user>/project-name>`
2813

29-
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
14+
Run:
15+
`docker run -p 8080:3000 <<user>/project-name>`
3016

31-
## Installation
17+
For Example:
18+
`docker build <your path> -t thomas-oliver/nestjs-dockerized`
19+
`docker run -p 8080:3000 thomas-oliver/nestjs-dockerized`
3220

33-
```bash
34-
$ npm install
35-
```
21+
Basic Docker Commands:
22+
List your docker images: `docker images`
23+
List your running containers: `docker ps`
24+
Kill a running container: `docker kill <id of container from docker ps (first 3 letters)>`, eg `docker kill fea`
3625

37-
## Running the app
3826

39-
```bash
40-
# development
41-
$ npm run start
4227

43-
# watch mode
44-
$ npm run start:dev
4528

46-
# production mode
47-
$ npm run start:prod
48-
```
4929

50-
## Test
51-
52-
```bash
53-
# unit tests
54-
$ npm run test
55-
56-
# e2e tests
57-
$ npm run test:e2e
58-
59-
# test coverage
60-
$ npm run test:cov
61-
```
62-
63-
## Support
64-
65-
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).
66-
67-
## Stay in touch
68-
69-
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
70-
- Website - [https://nestjs.com](https://nestjs.com/)
71-
- Twitter - [@nestframework](https://twitter.com/nestframework)
72-
73-
## License
74-
75-
Nest is [MIT licensed](LICENSE).

0 commit comments

Comments
 (0)