microsnail/node repository overview

⁠Node.js utilities

This image contains Node.js and several utilities based on JavaScript programing language. Besides Node.js itself, the image contains:

• npm
• Angular CLI
• web-push
• bcrypt (tag 10.15 and newer)
• pkg (tag 10.16 and newer)

More detailed description is in following chapters.

⁠How to use it

⁠General usage

In general you can use the image for any Node.js related tasks, just run

docker run microsnail/node <any node command>

If you run the image without any parameter, JavaScript REPL environment is launched.

⁠npm

npm is fundamental node.js package manager. The image uses it during build and can be also normaly used to install packages. Just run

docker run --rm microsnail/node npm <npm parameters>

Warning: Don't run npm install using this image towards Windows host filesystem as some packages use Unix-style links which might make problems. However, running npm install via Windows npm manager and then run node application via container with mounted application directory works without issues.

⁠Angular CLI

Angular is well known framework for web application development. This is its CLI package. To run its ng command, just run

docker run --rm microsnail/node ng <ng parameters>

Documentation of this package can be found here⁠.

⁠web-push

Web-push package can be used to send web-push notification from your application. We use this image to generate VAPID keys for example, using

docker run --rm microsnail/node web-push generate-vapid-keys

Documentation of this package can be found here⁠.

⁠bcrypt

The image includes bcryptjs package, which can be used to hash and verify strings. It's CLI version is specifically configured to be launched as easy as

docker run --rm microsnail/node bcrypt <string to be hashed>

Full documentation of this package can be found here⁠.

⁠pkg

pkg is a npm package providing compilation of node.js application into executable for different platforms (Windows, MacOS, Linux). It is launched by

docker run --rm microsnail/node pkg <node.js file to be compiled>

Full documentation of this package can be found here⁠.

⁠More resources

You can find more information (like Dockerfile, helper scripts and contact) at Microsnail docker apps and utils⁠ page.