feat: build and run from Docker Support

Build and run the generator from docker image support added.

The main aim and motivation behind doing this is, because
of a no. of different yo generators are there,
which are compatible and works with the different version of yo
and also might be incompatible with other generators or versions of yo.

Signed-off-by: Pratik Raj <[email protected]>

Author: Rajpratik71

README.md

@@ -19,6 +19,41 @@ Yeoman generator for creating RESTful NodeJS APIs, using ES6, Mongoose and Expre
 - Install the generator **globally**: `npm install -g generator-api`
 - Run: `yo api`, or `yo` and choose `Api` option
 
+## Using Docker
+
+Download the Dockerfile:
+
+```bash
+mkdir docker
+cd docker
+wget https://github.com/ndelvalle/generator-api/raw/master/docker/Dockerfile
+```
+
+Build the Docker images:
+
+```bash
+docker build -t generator-api:latest .
+```
+
+Make a folder where you want to generate the Service:
+
+```bash
+mkdir service
+cd service
+```
+
+Run the generator from image to generate service:
+
+```bash
+docker run -it --rm -v $PWD:/home/generator/app generator-api
+```
+
+Run and attach interactive shell to the generator docker container to work from inside the running container:
+
+```bash
+docker run -it --rm -v $PWD:/home/generator/app generator-api /bin/bash
+```
+
 ## Running the generated project
 
 Make sure you have node version `>= 6` because this project uses native supported ES6 features.

docker/Dockerfile

@@ -0,0 +1,50 @@
+FROM ubuntu:20.04
+RUN \
+  # configure the "generator" user
+  groupadd generator && \
+  useradd generator -s /bin/bash -m -g generator -G sudo && \
+  echo 'generator:generator' |chpasswd && \
+  mkdir /home/generator/app && \
+  export DEBIAN_FRONTEND=noninteractive && \
+  export TZ=Europe\Paris && \
+  ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone && \
+  apt-get update && \
+  # install utilities
+  apt-get install -y \
+    wget \
+    sudo && \
+  # install node.js
+  wget https://nodejs.org/dist/v12.18.4/node-v12.18.4-linux-x64.tar.gz -O /tmp/node.tar.gz && \
+  tar -C /usr/local --strip-components 1 -xzf /tmp/node.tar.gz && \
+  # upgrade npm
+  npm install -g npm && \
+  # install yeoman
+  npm install -g yo && \
+  # cleanup
+  apt-get clean && \
+  rm -rf \
+    /home/generator/.cache/ \
+    /var/lib/apt/lists/* \
+    /tmp/* \
+    /var/tmp/*
+
+RUN \
+  # install the generator
+  npm install -g generator-api && \
+  # fix generator user permissions
+  chown -R generator:generator \
+    /home/generator \
+    /usr/local/lib/node_modules && \
+  # cleanup
+  rm -rf \
+    /home/generator/.cache/ \
+    /var/lib/apt/lists/* \
+    /tmp/* \
+    /var/tmp/*
+
+# expose the working directory
+USER generator
+ENV PATH $PATH:/usr/bin
+WORKDIR "/home/generator/app"
+VOLUME ["/home/generator/app"]
+CMD ["yo", "api"]