Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kenec/dockrr
An npm package for generating docker file, building, running and stopping running docker image of a Node.js application.
https://github.com/kenec/dockrr
Last synced: 6 days ago
JSON representation
An npm package for generating docker file, building, running and stopping running docker image of a Node.js application.
- Host: GitHub
- URL: https://github.com/kenec/dockrr
- Owner: Kenec
- License: mit
- Created: 2019-07-21T18:57:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-19T18:00:17.000Z (over 4 years ago)
- Last Synced: 2024-10-11T00:46:47.511Z (28 days ago)
- Language: JavaScript
- Homepage:
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dockrr
[](https://travis-ci.org/Kenec/dockrr)
[](https://coveralls.io/github/Kenec/dockrr?branch=master)
**dockrr** is an an NPM package for auto generating Dockerfile, building docker image, running and stopping the docker container in Node.js.
## Installation
```
npm install dockrr --save-dev
```
## Configuration
1. Setup the dockrr config file in your application ***package.json*** file
```
...
"dockrr":{
"cmd": "node index.js",
"expose": 3000,
"env": [
{ "name": "name 1" },
{ "metadata": "meta data 1" },
{ "path": "Log Path 1" }
],
"label": [
{ "version": "1.0" },
{ "description": "A sample label" },
{ "maintainer": "[email protected]" }
],
"workdir": "/app"
},
```
2. Add script to generate Dockerfile, build docker image, start and stop docker container in your ***scripts*** section of ***package.json*** file
```
....
"scripts": {
"start": "node index.js",
"dockrr-generate": "node ./node_modules/dockrr generate",
"dockrr-build": "node ./node_modules/dockrr build",
"dockrr-run": "node ./node_modules/dockrr run",
"dockrr-stop": "node ./node_modules/dockrr stop"
},
```
Alternatively, we can use *dockrr* aliases such as
```
....
"scripts": {
"start": "node index.js",
"dockrr-generate": "node ./node_modules/dockrr g",
"dockrr-build": "node ./node_modules/dockrr b",
"dockrr-run": "node ./node_modules/dockrr r",
"dockrr-stop": "node ./node_modules/dockrr s"
},
```
### Usage
1. To generate Dockerfile for your application, run
```
npm run dockrr-generate
```
2. To build docker image using the generated Dockerfile, run
```
npm run dockrr-build
```
3. To run the docker container using the built image, run
```
npm run dockrr-run
```
***Visit the application on your web browser on `http://localhost:/`***
4. To stop the docker container, run
```
npm run dockrr-stop
```
### dockrr config commands
| Commands | Description | Type | Required |
| ------------- |:------------------------------------------------------------------|:--------------------| :---------|
| **cmd** | Command that docker will use to start your application | String | **True** |
| **expose** | The application port which you want the container to run on | Integer | **True** |
| **env** | The environment variables for docker | Array of Objects | **False** |
| **label** | Key value pair of metadata to the image | Array of Objects | **False** |
| **workdir** | The working directory in the Dockerfile | String | **False** |
### ISSUES
To report an issue or give feedback, Click link
[Issues and Feedback](https://github.com/Kenec/dockrr/issues)
### Contributing
We are more than happy to have you contribute to this project.
### License
[MIT](https://github.com/Kenec/dockrr/blob/master/LICENSE)