Skip to content

Commit 30eb6ff

Browse files
johnitvnjohnitvn
committed
docs: update document
1 parent 0747796 commit 30eb6ff

File tree

3 files changed

+63
-44
lines changed

3 files changed

+63
-44
lines changed

‎README.md

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,50 @@
1010
[![Contributors][contributors-shield]][contributors-url]
1111
[![MIT License][license-shield]][license-url]
1212

13-
Development infrastructure projects monorepo. This repo containt prebuilt devcontainer images, devcontainer features, nx plugins.
13+
Development infrastructure projects monorepo. This repo containt prebuilt devcontainer images, devcontainer features, docker images, nx plugins.
1414

1515
This project is mainly used internally within ebizbase projects but we have decided to share the entire source code of the project for the community to use and contribute.
1616

1717
## List of packages
1818

1919
### devcontainer features
2020

21-
| Name | Description|
22-
| ---------- | ---------- |
23-
| [omz-plugin][omz-plugin-readme] | This feature will install and active plugins for oh my zsh |
24-
| [install-npm-package-globally][install-npm-package-globally-readme] | This feature will be install npm packages globally |
25-
| [powerlevel10k][powerlevel10k-readme] | This feature will install, activate and config powerlevel10k theme for oh my zsh |
26-
| [npm-playwright][npm-playwright-readme] | This feature will be install playwright via npm with os dependencies and browser binaries |
21+
| Name | Description |
22+
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
23+
| [omz-plugin][omz-plugin-readme] | This feature will install and active plugins for oh my zsh |
24+
| [install-npm-package-globally][install-npm-package-globally-readme] | This feature will be install npm packages globally |
25+
| [powerlevel10k][powerlevel10k-readme] | This feature will install, activate and config powerlevel10k theme for oh my zsh |
26+
| [npm-playwright][npm-playwright-readme] | This feature will be install playwright via npm with os dependencies and browser binaries |
2727

28+
### devcontainer images
2829

29-
### devconainer images
30+
| Name | Description |
31+
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32+
| [base-devcontainer][base-devcontainer-readme] | The [`base-devcontainer`][base-devcontainer-readme] is a prebuild devcontainer image base on debian with common-utils and provide good experiences interacting with the zsh shell |
33+
| [node-devcontainer][node-devcontainer-readme] | The image base on [`base-devcontainer`][base-devcontainer-readme] with latest NodeJS LTS version (includes npm, pnpm, yarn, bun) |
34+
| [node-dind-devcontainer][node-dind-devcontainer-readme] | The image base on [`node-devcontainer`][node-devcontainer-readme] with docker in docker |
35+
| [node-dind-playwright-devcontainer][node-dind-playwright-devcontainer-readme] | The image base on [`node-dind-devcontainer`][node-dind-devcontainer-readme] with playwright installed (both OS dependencies and browser binary) |
36+
| [node-playwright-devcontainer][node-playwright-devcontainer-readme] | The image base on [`node-devcontainer`][node-devcontainer-readme] with playwright installed (both OS dependencies and browser binary) |
3037

31-
| Name | Description|
32-
| ---------- | ---------- |
33-
| [base-devcontainer][base-devcontainer-readme] | The `base-devcontainer` is a prebuild devcontainer image base on debian with common-utils and provide good experiences interacting with the zsh shell |
34-
| [node-devcontainer][node-devcontainer-readme] | The image base on `base-devcontainer` with latest NodeJS LTS version (includes npm, pnpm, yarn, bun) |
35-
| [node-dind-devcontainer][node-dind-devcontainer-readme] |The image base on `node-devcontainer` with docker in docker |
36-
| [node-dind-playwright-devcontainer][node-dind-playwright-devcontainer-readme] |The image base on `node-dind-devcontainer` with playwright installed (both OS dependencies and browser binary) |
37-
[node-playwright-devcontainer][node-playwright-devcontainer-readme] |The image base on `node-devcontainer` with playwright installed (both OS dependencies and browser binary) |
38+
### docker images
39+
40+
| Name | Description |
41+
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
42+
| [node-distroless][node-distroless-readme] | This image combines the compactness and security of distroless with the convenience of dumb-init for process management, making Node.js applications run more stably in a container environment. |
43+
| [nginx-spa][node-distroless-readme] | This docker image can be used for single page apps. It serves your index.html if no other file matches. |
3844

3945
### npm packages
40-
| Name | Description|
41-
| ---------- | ---------- |
42-
| [nx-devkit][nx-devkit-readme] | It contains many utility functions for interactive with nx workspace and projects |
46+
47+
| Name | Description |
48+
| ----------------------------- | --------------------------------------------------------------------------------- |
49+
| [nx-devkit][nx-devkit-readme] | It contains many utility functions for interactive with nx workspace and projects |
4350

4451
### nx plugins
45-
| Name | Description|
46-
| ---------- | ---------- |
47-
| [nx-docker][nx-docker-readme] | The NX plugin to build and push docker image
48-
| [nx-dive][nx-dive-readme] | The NX plugin exploring a docker image, layer contents, and discovering ways to shrink the size of your Docker/OCI image base on [dive](https://github.com/wagoodman/dive)
52+
53+
| Name | Description |
54+
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55+
| [nx-docker][nx-docker-readme] | The NX plugin to build and push docker image |
56+
| [nx-dive][nx-dive-readme] | The NX plugin exploring a docker image, layer contents, and discovering ways to shrink the size of your Docker/OCI image base on [dive](https://github.com/wagoodman/dive) |
4957

5058
<p align="right">(<a href="#readme-top">back to top</a>)</p>
5159

@@ -81,19 +89,17 @@ Distributed under the MIT License. See [LICENSE][license-url] for more informati
8189
[license-shield]: https://img.shields.io/github/license/ebizbase/dev-infras.svg
8290
[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt
8391
[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md
84-
[npm-playwright-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/npm-playwright/README.md
92+
[npm-playwright-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/npm-playwright/README.md
8593
[omz-plugin-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/omz-plugin/README.md
8694
[install-npm-package-globally-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/install-npm-package-globally/README.md
8795
[powerlevel10k-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/powerlevel10k/README.md
88-
89-
[base-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/base-devcontainer/README.md
90-
[node-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-devcontainer/README.md
91-
[node-dind-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-devcontainer/README.md
92-
[node-playwright-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-playwright-devcontainer/README.md
93-
[node-dind-playwright-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-playwright-devcontainer/README.md
94-
95-
96+
[base-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/base-devcontainer/README.md
97+
[node-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-devcontainer/README.md
98+
[node-dind-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-devcontainer/README.md
99+
[node-playwright-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-playwright-devcontainer/README.md
100+
[node-dind-playwright-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-playwright-devcontainer/README.md
96101
[nx-devkit-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-devkit/README.md
97-
98102
[nx-docker-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-docker/README.md
99-
[nx-dive-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-dive/README.md
103+
[nx-dive-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-dive/README.md
104+
[node-distroless-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/node-distroless/README.md
105+
[nginx-spa-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/nginx-spa/README.md

‎images/nginx-spa/README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# node-distroless
22

3-
This image combines the compactness and security of distroless with the convenience of dumb-init for process management, making Node.js applications run more stably in a container environment.
3+
This docker image can be used for single page apps. It serves your index.html if no other file matches.
44

5-
> This image is maintained with node latest LTS version
5+
> This image is maintained with node latest stable nginx version
66
77
## Usage
88

9-
The simple usage example
10-
119
```dockerfile
12-
FROM ghcr.io/ebizbase/node-distroless
13-
WORKDIR /usr/src/app
14-
COPY . .
15-
CMD [ "index.js" ]
10+
FROM ghcr.io/ebizbase/nginx-spa
11+
WORKDIR /app
12+
COPY dist/ .
1613
```
14+
15+
Simply run your container as follows:
16+
17+
```shell
18+
docker build -t your-app .
19+
docker run -p 8000:80 your-app
20+
```
21+
22+
Now you can visit http://localhost:8000/ in your browser or run curl -v http://localhost:8000/ to check if it's working.

‎images/node-distroless/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,18 @@ This image combines the compactness and security of distroless with the convenie
66
77
## Usage
88

9-
The simple usage example
9+
To create your own dockerfile, simply copy your distribution folder (often dist/ or build/) to /app into the image.
1010

1111
```dockerfile
1212
FROM ghcr.io/ebizbase/node-distroless
13-
WORKDIR /usr/src/app
14-
COPY . .
13+
WORKDIR /app
14+
COPY /dist .
1515
CMD [ "index.js" ]
1616
```
17+
18+
Simply run your container as follows:
19+
20+
```shell
21+
docker build -t your-app .
22+
docker run your-app
23+
```

0 commit comments

Comments
 (0)