Skip to content

Commit efe33dd

Browse files
committed
Improving README
1 parent aad7b97 commit efe33dd

1 file changed

Lines changed: 64 additions & 37 deletions

File tree

README.md

Lines changed: 64 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,77 @@
1-
# kool-dev/docker-node
1+
![CI/CD](https://github.com/kool-dev/docker-node/workflows/CI/CD/badge.svg)
22

3-
<p align="center">
4-
<a href="https://github.com/kool-dev/docker-node/actions"><img src="https://github.com/kool-dev/docker-node/workflows/CI/badge.svg" alt="Github Actions Build Status"></a>
5-
</p>
3+
## Description
64

7-
Minimal Node Docker image focused on Laravel applications. Its use is intended for [fwd](https://github.com/kool-dev/fwd), but can fit in any other Node use-case.
5+
Minimal [Node](https://nodejs.org/en/) Docker image. It's use is intended for [kool.dev](https://github.com/kool-dev/kool), but can fit in any other Node use-case.
6+
7+
## Available Tags
8+
9+
### 10
10+
11+
- [10](https://github.com/kool-dev/docker-node/blob/master/10/Dockerfile)
12+
- [10-qa](https://github.com/kool-dev/docker-node/blob/master/10-qa/Dockerfile)
13+
- [10-adonis](https://github.com/kool-dev/docker-node/blob/master/10-adonis/Dockerfile)
14+
- [10-adonis-qa](https://github.com/kool-dev/docker-node/blob/master/10-adonis-qa/Dockerfile)
15+
- [10-nest](https://github.com/kool-dev/docker-node/blob/master/10-nest/Dockerfile)
16+
- [10-nest-qa](https://github.com/kool-dev/docker-node/blob/master/10-nest-qa/Dockerfile)
17+
18+
### 12
19+
20+
- [12](https://github.com/kool-dev/docker-node/blob/master/12/Dockerfile)
21+
- [12-qa](https://github.com/kool-dev/docker-node/blob/master/12-qa/Dockerfile)
22+
- [12-adonis](https://github.com/kool-dev/docker-node/blob/master/12-adonis/Dockerfile)
23+
- [12-adonis-qa](https://github.com/kool-dev/docker-node/blob/master/12-adonis-qa/Dockerfile)
24+
- [12-nest](https://github.com/kool-dev/docker-node/blob/master/12-nest/Dockerfile)
25+
- [12-nest-qa](https://github.com/kool-dev/docker-node/blob/master/12-nest-qa/Dockerfile)
26+
27+
### 14
28+
29+
- [14](https://github.com/kool-dev/docker-node/blob/master/14/Dockerfile)
30+
- [14-qa](https://github.com/kool-dev/docker-node/blob/master/14-qa/Dockerfile)
31+
- [14-adonis](https://github.com/kool-dev/docker-node/blob/master/14-adonis/Dockerfile)
32+
- [14-adonis-qa](https://github.com/kool-dev/docker-node/blob/master/14-adonis-qa/Dockerfile)
33+
- [14-nest](https://github.com/kool-dev/docker-node/blob/master/14-nest/Dockerfile)
34+
- [14-nest-qa](https://github.com/kool-dev/docker-node/blob/master/14-nest-qa/Dockerfile)
35+
36+
## Environment Variables
37+
38+
Variable | Description | Default Value
39+
--- | --- | ---
40+
**ASUSER** | Changes the user id that executes the commands | `-0`
41+
**UID** | Changes the user id that executes the commands **(ignored if ASUSER is provided)** | `-0`
842

943
## Usage
1044

1145
With `docker run`:
1246

1347
```sh
14-
docker run -it --rm kooldev/node:alpine node -v
48+
docker run -it --rm kooldev/node:14 node -v
49+
```
50+
51+
With environment variables:
52+
53+
```sh
54+
docker run -it --rm -e ASUSER=500 kooldev/node:14 node -v
55+
```
56+
57+
With `docker-compose.yml`:
58+
59+
```yaml
60+
app:
61+
image: kooldev/node:14
62+
environment:
63+
ASUSER: "${$UID}"
1564
```
1665
17-
### Available Tags
18-
19-
- **10**: Node 10
20-
- **10-qa**: Node 10 with QA Utilities: `buddy.js jshint jsinspect eslint`
21-
- **10-andois**: Node 10 with Adonis
22-
- **10-andois-qa**: Node 10 with Adonis and QA Utilities: `buddy.js jshint jsinspect eslint`
23-
- **10-nest**: Node 10 with Nest
24-
- **10-nest-qa**: Node 10 with Nest and QA Utilities: `buddy.js jshint jsinspect eslint`
25-
- **12**: Node 12
26-
- **12-qa**: Node 12 with QA Utilities: `buddy.js jshint jsinspect eslint`
27-
- **12-andois**: Node 12 with Adonis
28-
- **12-andois-qa**: Node 12 with Adonis and QA Utilities: `buddy.js jshint jsinspect eslint`
29-
- **12-nest**: Node 12 with Nest
30-
- **12-nest-qa**: Node 12 with Nest and QA Utilities: `buddy.js jshint jsinspect eslint`
31-
- **14**: Node 14
32-
- **14-qa**: Node 14 with QA Utilities: `buddy.js jshint jsinspect eslint`
33-
- **14-andois**: Node 14 with Adonis
34-
- **14-andois-qa**: Node 14 with Adonis and QA Utilities: `buddy.js jshint jsinspect eslint`
35-
- **14-nest**: Node 14 with Nest
36-
- **14-nest-qa**: Node 14 with Nest and QA Utilities: `buddy.js jshint jsinspect eslint`
37-
- **latest**: Node 14
38-
- **qa**: Node 14 with QA Utilities: `buddy.js jshint jsinspect eslint`
39-
- **andois**: Node 14 with Adonis
40-
- **andois-qa**: Node 14 with Adonis and QA Utilities: `buddy.js jshint jsinspect eslint`
41-
- **nest**: Node 14 with Nest
42-
- **nest-qa**: Node 14 with Nest and QA Utilities: `buddy.js jshint jsinspect eslint`
43-
44-
45-
### Variables
46-
47-
**ASUSER**: Changes the user id that executes the commands
66+
## Contributing
67+
68+
### Dependencies
69+
70+
- [fwd](https://github.com/fireworkweb/fwd#fireworkwebfwd)
71+
72+
You should change `fwd-template.json` and `template` folder.
73+
74+
After your changes, just run `fwd template` to compile the template and generate all version folder/files.
4875

4976
## License
5077

0 commit comments

Comments
 (0)