From f91f4987c628c483884a2b691a25f510a30edb96 Mon Sep 17 00:00:00 2001 From: John Martin Date: Sun, 24 Nov 2024 17:20:05 +0000 Subject: [PATCH] docs: update document --- README.md | 72 ++++++++++--------- .../install-npm-package-globally/README.md | 30 ++++++++ .../npm-playwright/README.md | 32 ++++++++- devcontainer-features/omz-plugin/README.md | 44 ++++++++++-- devcontainer-features/powerlevel10k/README.md | 31 ++++++++ .../base-devcontainer/README.md | 29 ++++++++ .../node-devcontainer/README.md | 33 ++++++++- .../node-dind-devcontainer/README.md | 32 ++++++++- .../README.md | 29 ++++++++ .../node-playwright-devcontainer/README.md | 30 ++++++++ images/nginx-spa/README.md | 53 +++++++++++--- images/node-distroless/README.md | 46 ++++++++++-- packages/nx-devkit/README.md | 35 ++++++++- packages/nx-dive/README.md | 34 ++++++++- packages/nx-docker/README.md | 1 + 15 files changed, 475 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 193e30c..9f85dc7 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![Contributors][contributors-shield]][contributors-url] [![MIT License][license-shield]][license-url] -Development infrastructure projects monorepo. This repo containt prebuilt devcontainer images, devcontainer features, nx plugins. +Development infrastructure projects monorepo. This repo containt prebuilt devcontainer images, devcontainer features, docker images, nx plugins. 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. @@ -18,34 +18,42 @@ This project is mainly used internally within ebizbase projects but we have deci ### devcontainer features -| Name | Description| -| ---------- | ---------- | -| [omz-plugin][omz-plugin-readme] | This feature will install and active plugins for oh my zsh | -| [install-npm-package-globally][install-npm-package-globally-readme] | This feature will be install npm packages globally | -| [powerlevel10k][powerlevel10k-readme] | This feature will install, activate and config powerlevel10k theme for oh my zsh | -| [npm-playwright][npm-playwright-readme] | This feature will be install playwright via npm with os dependencies and browser binaries | +| Name | Description | +| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| [omz-plugin][omz-plugin-readme] | This feature will install and active plugins for oh my zsh | +| [install-npm-package-globally][install-npm-package-globally-readme] | This feature will be install npm packages globally | +| [powerlevel10k][powerlevel10k-readme] | This feature will install, activate and config powerlevel10k theme for oh my zsh | +| [npm-playwright][npm-playwright-readme] | This feature will be install playwright via npm with os dependencies and browser binaries | +### devcontainer images -### devconainer images +| Name | Description | +| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [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 | +| [node-devcontainer][node-devcontainer-readme] | The image base on [`base-devcontainer`][base-devcontainer-readme] with latest NodeJS LTS version (includes npm, pnpm, yarn, bun) | +| [node-dind-devcontainer][node-dind-devcontainer-readme] | The image base on [`node-devcontainer`][node-devcontainer-readme] with docker in docker | +| [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) | +| [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) | -| Name | Description| -| ---------- | ---------- | -| [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 | -| [node-devcontainer][node-devcontainer-readme] | The image base on `base-devcontainer` with latest NodeJS LTS version (includes npm, pnpm, yarn, bun) | -| [node-dind-devcontainer][node-dind-devcontainer-readme] |The image base on `node-devcontainer` with docker in docker | -| [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) | -[node-playwright-devcontainer][node-playwright-devcontainer-readme] |The image base on `node-devcontainer` with playwright installed (both OS dependencies and browser binary) | +### docker images + +| Name | Description | +| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [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. | +| [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. | ### npm packages -| Name | Description| -| ---------- | ---------- | -| [nx-devkit][nx-devkit-readme] | It contains many utility functions for interactive with nx workspace and projects | + +| Name | Description | +| ----------------------------- | --------------------------------------------------------------------------------- | +| [nx-devkit][nx-devkit-readme] | It contains many utility functions for interactive with nx workspace and projects | ### nx plugins -| Name | Description| -| ---------- | ---------- | -| [nx-docker][nx-docker-readme] | The NX plugin to build and push docker image -| [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) + +| Name | Description | +| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [nx-docker][nx-docker-readme] | The NX plugin to build and push docker image | +| [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) |

(back to top)

@@ -81,19 +89,17 @@ Distributed under the MIT License. See [LICENSE][license-url] for more informati [license-shield]: https://img.shields.io/github/license/ebizbase/dev-infras.svg [license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt [contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md -[npm-playwright-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/npm-playwright/README.md +[npm-playwright-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/npm-playwright/README.md [omz-plugin-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/omz-plugin/README.md [install-npm-package-globally-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/install-npm-package-globally/README.md [powerlevel10k-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-features/powerlevel10k/README.md - -[base-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/base-devcontainer/README.md -[node-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-devcontainer/README.md -[node-dind-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-devcontainer/README.md -[node-playwright-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-playwright-devcontainer/README.md -[node-dind-playwright-devcontainer-readme]:https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-playwright-devcontainer/README.md - - +[base-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/base-devcontainer/README.md +[node-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-devcontainer/README.md +[node-dind-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-devcontainer/README.md +[node-playwright-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-playwright-devcontainer/README.md +[node-dind-playwright-devcontainer-readme]: https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/node-dind-playwright-devcontainer/README.md [nx-devkit-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-devkit/README.md - [nx-docker-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-docker/README.md -[nx-dive-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-dive/README.md \ No newline at end of file +[nx-dive-readme]: https://github.com/ebizbase/dev-infras/blob/main/packages/nx-dive/README.md +[node-distroless-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/node-distroless/README.md +[nginx-spa-readme]: https://github.com/ebizbase/dev-infras/blob/main/images/nginx-spa/README.md diff --git a/devcontainer-features/install-npm-package-globally/README.md b/devcontainer-features/install-npm-package-globally/README.md index 2f3a59e..23d24a6 100644 --- a/devcontainer-features/install-npm-package-globally/README.md +++ b/devcontainer-features/install-npm-package-globally/README.md @@ -39,3 +39,33 @@ Install semver version | Options Id | Description | Type | Default | | ---------- | ------------------------------------------------------------------------------------------------------------------------------- | ----- | ------- | | packages | List of npm packages to install globally sparate by comma. We accept specific version with semver (eg 'typescript,nx@^20.0.12') | array | [] | + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. +- Verify package name and version is avaiable + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/devcontainer-features/npm-playwright/README.md b/devcontainer-features/npm-playwright/README.md index bbccaa2..23fbef9 100644 --- a/devcontainer-features/npm-playwright/README.md +++ b/devcontainer-features/npm-playwright/README.md @@ -10,4 +10,34 @@ Install latest version "features": { "ghcr.io/ebizbase/devcontainer-features/npm-playwright:1": {} } -``` \ No newline at end of file +``` + + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/devcontainer-features/omz-plugin/README.md b/devcontainer-features/omz-plugin/README.md index 92211b4..8ad1259 100644 --- a/devcontainer-features/omz-plugin/README.md +++ b/devcontainer-features/omz-plugin/README.md @@ -1,18 +1,23 @@ # omz-plugin devcontainer feature -This feature will install and active plugins for oh my zsh +Oh My Zsh is a delightful, open source, community-driven framework for managing your Zsh configuration. It comes bundled with thousands of helpful functions, helpers, plugins, themes. + +This feature installs and activates plugins for Oh My Zsh. Helps enhance the command line experience and productivity ## Example Usage ```json "features": { "ghcr.io/ebizbase/devcontainer-features/omz-plugin:1": { - "preInstalledPlugins": ["git", "git-auto-fetch"], + "preInstalledPlugins": [ + "git", + "git-auto-fetch" + ], "customPlugins": [ "zsh-syntax-highlighting:https://github.com/zsh-users/zsh-syntax-highlighting.git", "zsh-autosuggestions:https://github.com/zsh-users/zsh-autosuggestions/archive/refs/tags/v0.7.1.zip" ], - "deleteInactive": false, + "deleteInactive": false } } ``` @@ -22,9 +27,40 @@ This feature will install and active plugins for oh my zsh | Options Id | Description | Type | Default | | ------------------- | --------------------------------------------------------------------------------------------- | ----- | ------- | | preInstalledPlugins | The list of pre-installed oh-my-zsh plugins to active (e.g. git,git-auto-fetch) (\*) | array | ["git"] | -| customPlugins | The list of custom plugin you want to install with plugin-name1:url1,plugin-name2:url1 (\*\*) | array | [] | +| customPlugins | The list of custom plugins you want to install, using the format `plugin-name:url` (\*\*) | array | [] | | deleteInactive | Should delete inactive plugins or not | bool | false | **(\*)** See [list of oh-my-zsh preinstalled plugins](https://github.com/ohmyzsh/ohmyzsh/wiki/plugins) **(\*\*)** We support zip release url or git url. See example [here](https://github.com/ebizbase/dev-infras/blob/main/devcontainer-images/base-devcontainer/devcontainer.json) + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. +- Verify the plugin URLs are accessible and valid (e.g., Git repository links or release ZIP URLs). + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt + diff --git a/devcontainer-features/powerlevel10k/README.md b/devcontainer-features/powerlevel10k/README.md index c335235..050dbf0 100644 --- a/devcontainer-features/powerlevel10k/README.md +++ b/devcontainer-features/powerlevel10k/README.md @@ -31,3 +31,34 @@ You can define custom config file | config | Powerlevel10k configuration file url | string | https://raw.githubusercontent.com/ebizbase/dev-infras/refs/heads/main/devcontainer-features/powerlevel10k/p10k.zsh | | version | Powerlevel10k version | string | "latest" | | deletePreinstalledThemes | Should delete pre installed themes or not | boolean | false | + + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. +- Verify the config URL are accessible and valid. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/devcontainer-images/base-devcontainer/README.md b/devcontainer-images/base-devcontainer/README.md index d70132b..8ea187c 100644 --- a/devcontainer-images/base-devcontainer/README.md +++ b/devcontainer-images/base-devcontainer/README.md @@ -1,3 +1,32 @@ # Base Devcontainer The `base-devcontainer` is a prebuild devcontainer image base on debian with common-utils and provide good experiences interacting with the zsh shell + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/devcontainer-images/node-devcontainer/README.md b/devcontainer-images/node-devcontainer/README.md index b9c7956..4a298c4 100644 --- a/devcontainer-images/node-devcontainer/README.md +++ b/devcontainer-images/node-devcontainer/README.md @@ -1,3 +1,34 @@ # Node Devcontainer -The image base on `base-devcontainer` with latest NodeJS LTS version (includes npm, pnpm, yarn, bun) +The image base on `base-devcontainer` with latest NodeJS LTS version (includes packages mangers: npm, pnpm, yarn, bun) + +> This image is maintained with NodeJS latest LTS version + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/devcontainer-images/node-dind-devcontainer/README.md b/devcontainer-images/node-dind-devcontainer/README.md index b5e7d0f..3a26413 100644 --- a/devcontainer-images/node-dind-devcontainer/README.md +++ b/devcontainer-images/node-dind-devcontainer/README.md @@ -1,3 +1,33 @@ # Node Dind Devcontainer -The image base on `node-devcontainer` with docker in docker +The image base on `node-devcontainer` with docker in docker (includes docker-compose, mobu-buildx) + + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/devcontainer-images/node-dind-playwright-devcontainer/README.md b/devcontainer-images/node-dind-playwright-devcontainer/README.md index e5570a7..ea083a6 100644 --- a/devcontainer-images/node-dind-playwright-devcontainer/README.md +++ b/devcontainer-images/node-dind-playwright-devcontainer/README.md @@ -1,3 +1,32 @@ # Node Dind Playwright Devcontainer The image base on `node-dind-devcontainer` with playwright installed (both OS dependencies and browser binary) + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/devcontainer-images/node-playwright-devcontainer/README.md b/devcontainer-images/node-playwright-devcontainer/README.md index f6291e7..21cd6e3 100644 --- a/devcontainer-images/node-playwright-devcontainer/README.md +++ b/devcontainer-images/node-playwright-devcontainer/README.md @@ -1,3 +1,33 @@ # Node Playwright Devcontainer The image base on `node-devcontainer` with playwright installed (both OS dependencies and browser binary) + + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/images/nginx-spa/README.md b/images/nginx-spa/README.md index aded9a7..b0ee07c 100644 --- a/images/nginx-spa/README.md +++ b/images/nginx-spa/README.md @@ -1,16 +1,53 @@ # node-distroless -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. +This docker image can be used for single page apps. It serves your index.html if no other file matches. -> This image is maintained with node latest LTS version +> This image is maintained with node latest stable nginx version ## Usage -The simple usage example - ```dockerfile -FROM ghcr.io/ebizbase/node-distroless -WORKDIR /usr/src/app -COPY . . -CMD [ "index.js" ] +FROM ghcr.io/ebizbase/nginx-spa +WORKDIR /app +COPY dist/ . ``` + +Simply run your container as follows: + +```shell +docker build -t your-app . +docker run -p 8000:80 your-app +``` + +Now you can visit http://localhost:8000/ in your browser or run curl -v http://localhost:8000/ to check if it's working. + + + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/images/node-distroless/README.md b/images/node-distroless/README.md index aded9a7..8b2cf81 100644 --- a/images/node-distroless/README.md +++ b/images/node-distroless/README.md @@ -2,15 +2,53 @@ 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. -> This image is maintained with node latest LTS version +> This image is maintained with NodeJS latest LTS version ## Usage -The simple usage example +To create your own dockerfile, simply copy your distribution folder (often dist/ or build/) to /app into the image. ```dockerfile FROM ghcr.io/ebizbase/node-distroless -WORKDIR /usr/src/app -COPY . . +WORKDIR /app +COPY /dist . CMD [ "index.js" ] ``` + +Simply run your container as follows: + +```shell +docker build -t your-app . +docker run your-app +``` + + + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/packages/nx-devkit/README.md b/packages/nx-devkit/README.md index 53214f2..288fdae 100644 --- a/packages/nx-devkit/README.md +++ b/packages/nx-devkit/README.md @@ -2,13 +2,15 @@ It contains many utility functions for interactive with nx workspace and projects - ## Installation To install the package, run: ```bash -npm install @ebizbase/nx-devkit +npm install -D @ebizbase/nx-devkit +yarn add -D @ebizbase/nx-devkit +pnpm add -D @ebizbase/nx-devkit +bun add -D @ebizbase/nx-devkit ``` ## Usage @@ -47,3 +49,32 @@ const executor: PromiseExecutor = async (options, context) const projectName: projectUtils.getProjectName(); }; ``` + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + +## License + +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/packages/nx-dive/README.md b/packages/nx-dive/README.md index d1c2165..a328978 100644 --- a/packages/nx-dive/README.md +++ b/packages/nx-dive/README.md @@ -1,5 +1,8 @@ # nx-dive -The NX plugin to using [dive](https://github.com/wagoodman/dive) for analyze image + +[dive](https://github.com/wagoodman/dive) is a tool for exploring a docker image, layer contents, and discovering ways to shrink the size of your Docker/OCI image. + +@ebizbase/nx-dive is a nx plugin for [dive](https://github.com/wagoodman/dive) ## Prerequisites @@ -14,6 +17,7 @@ To install plugin run the following command: npm install -D @ebizbase/nx-dive yarn add -D @ebizbase/nx-dive pnpm add -D @ebizbase/nx-dive +bun add -D @ebizbase/nx-dive ``` ## Analyze docker image @@ -75,6 +79,32 @@ Bellow is all options of @ebizbase/nx-docker:analyze To check all possible options please check this [schema.json](./src/executors/analyze/schema.json) file + +## Contributing + +We welcome contributions! Fork the repo, create a pull request, or open an issue with the "enhancement" tag. See [Contribution Guidelines][contribution-guidelines-url] for details. + +## Issues + +If you encounter any issues while using this feature, please check the following before creating a new issue: +- Ensure your JSON configuration is correctly formatted. Refer to the Example Usage section for guidance. + +If the issue persists, feel free to: + +- Open an issue on the [GitHub issues page][issues-url] +- Provide detailed information, including: + - A description of the issue. + - Steps to reproduce the problem. + - Logs or error messages, if applicable. + - Your devcontainer setup (e.g., OS, DevContainer version). + +Our team will review and address your issue as soon as possible. For faster resolution, ensure your report is clear and well-documented. + + ## License -This project is licensed under the MIT License. \ No newline at end of file +Distributed under the MIT License. See [LICENSE][license-url] for more information. + +[issues-url]: https://github.com/ebizbase/dev-infras/issues +[contribution-guidelines-url]: https://github.com/ebizbase/dev-infras/blob/main/CONTRIBUTING.md +[license-url]: https://github.com/ebizbase/dev-infras/blob/main/LICENSE.txt \ No newline at end of file diff --git a/packages/nx-docker/README.md b/packages/nx-docker/README.md index b2f78de..ef2b8f2 100644 --- a/packages/nx-docker/README.md +++ b/packages/nx-docker/README.md @@ -15,6 +15,7 @@ To install plugin run the following command: npm install -D @ebizbase/nx-docker yarn add -D @ebizbase/nx-docker pnpm add -D @ebizbase/nx-docker +bun add -D @ebizbase/nx-docker ``` ## Build image