main: adding multi-stage-build code

Author: thiagoolsilva

README.md

@@ -1,2 +1,112 @@
-# multi-stage-build-docker-example
-This is a very example the use of multi stage docker build that improve the docker's image size.
+# Welcome to multi-stage-build-docker-example 👋
+![Version](https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000)
+[![Twitter: thiagoolsilva](https://img.shields.io/twitter/follow/thiagoolsilva.svg?style=social)](https://twitter.com/thiagoolsilva)
+
+> This is a very simple example the use of multi stage docker build that improve the docker's image size.
+
+### 🏠 [Homepage](https://github.com/thiagoolsilva/multi-stage-build-docker-example)
+
+
+## Why use multi stage docker build?
+According to the official documentation, the use of multi stage docker build will help us as the following description.
+
+> One of the most challenging things about building images is keeping the image size down. Each instruction in the Dockerfile adds a layer to the image, and you need to remember to clean up any artifacts you don’t need before moving on to the next layer. To write a really efficient Dockerfile, you have traditionally needed to employ shell tricks and other logic to keep the layers as small as possible and to ensure that each layer has the artifacts it needs from the previous layer and nothing else.
+
+> It was actually very common to have one Dockerfile to use for development (which contained everything needed to build your application), and a slimmed-down one to use for production, which only contained your application and exactly what was needed to run it. This has been referred to as the “builder pattern”. Maintaining two Dockerfiles is not ideal.
+
+Source: https://docs.docker.com/develop/develop-images/multistage-build/
+
+
+## Which scenarios are recommended to use the multi stage docker?
+
+As described before, I can resume the use of multi docker build in the following use cases.
+
+* Reduce the final docker build image;
+* Split the build, Run and etc... to stages phases;
+* Cache the build Stages;
+
+# Multi Stage Build
+
+This is a piece of multi stage dockerfile split up in two stages. The first one will create a docker to build the code and the second one will get the output of first one 
+using the code `COPY --from=buildStage /app/dist/ /app/` due to improve the final docker image size. 
+
+```
+# Stage 1: Build the base code. 
+FROM node:14.17.0-alpine as buildStage
+
+LABEL stage="builder"
+
+...
+
+# Stage 2. Run build container code using the code from buildStage phase.
+FROM node:14.17.0-alpine
+LABEL author="Thiago lopes da Silva<thiagoolsilva@gmail.com>"
+
+...
+
+COPY --from=buildStage /app/dist/ /app/
+
+...
+```
+[Full dockerfile code](script/docker/dockerfile)
+
+
+## Do you want more details about this topic?
+
+Please give it a try and go to the post that I've created about this topic in the [medium](https://thiagolopessilva.medium.com/)
+
+> The post was written in the Portuguese language.
+
+## Install
+
+```sh
+yarn install
+```
+
+## Build
+
+```sh
+yarn build-clean
+```
+
+## Usage
+```sh
+yarn docker:run
+
+$output:
+The method main() was called.
+calling the uuid.v4()
+Result: 032e4c47-0635-4e84-87b1-724d6e4be3f1
+Done in 0.69s.
+```
+
+
+
+## Author
+
+👤 **Thiago lopes da silva <thiagoolsilva@gmail.com>**
+
+* Website: https://medium.com/@thiagolopessilva
+* Twitter: [@thiagoolsilva](https://twitter.com/thiagoolsilva)
+* Github: [@thiagoolsilva](https://github.com/thiagoolsilva)
+* LinkedIn: [@https:\/\/www.linkedin.com\/in\/thiago-lopes-silva-2b943a25\/](https://linkedin.com/in/https:\/\/www.linkedin.com\/in\/thiago-lopes-silva-2b943a25\/)
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!
+
+Feel free to check [issues page](https://github.com/thiagoolsilva/multi-stage-build-docker-example/issues). 
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+
+## 📝 License
+
+Copyright © 2021 [Thiago lopes da silva <thiagoolsilva@gmail.com>](https://github.com/thiagoolsilva).
+
+This project is [Apache V2](https://github.com/thiagoolsilva/multi-stage-build-docker-example/blob/main/LICENSE) licensed.
+
+***
+_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "multi-stage-build-docker-example",
+  "version": "1.0.0",
+  "description": "This is a very simple example the use of multi stage docker build that improve the docker's image size.",
+  "main": "dist/index.js",
+  "repository": "git@github.com:thiagoolsilva/multi-stage-build-docker-example.git",
+  "author": "Thiago lopes da silva <thiagoolsilva@gmail.com>",
+  "license": "Apache V2",
+  "private": true,
+  "scripts": {
+    "build": "./node_modules/.bin/tsc ",
+    "docker:build-clean": "yarn docker:build && yarn docker:clean-stage-build",
+    "docker:build": "docker build --file=./script/docker/dockerfile --tag=multi-stage-build .",
+    "docker:run": "docker run --rm -it multi-stage-build",
+    "docker:clean-stage-build": "docker image prune --force --filter label=stage=builder"
+  },
+  "devDependencies": {
+    "@types/uuid": "8.3.2",
+    "typescript": "4.4.3"
+  },
+  "dependencies": {
+    "uuid": "8.3.2"
+  }
+}

script/docker/dockerfile

@@ -0,0 +1,47 @@
+#   Copyright (c) 2021  Thiago Lopes da Silva
+ 
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+ 
+#       http://www.apache.org/licenses/LICENSE-2.0
+ 
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+# Stage 1: Build the base code. 
+FROM node:14.17.0-alpine as buildStage
+
+LABEL stage="builder"
+
+WORKDIR /app
+
+COPY . /app
+
+RUN [ "yarn" ]
+
+RUN [ "yarn", "build" ]
+
+RUN ["rm", "-rf", "node_modules"]
+
+RUN [ "yarn", "--production" ]
+
+# Stage 2. Run build container code using the code from buildStage phase.
+FROM node:14.17.0-alpine
+LABEL author="Thiago lopes da Silva<thiagoolsilva@gmail.com>"
+
+RUN apk update && apk add bash
+
+WORKDIR /app
+
+RUN addgroup -S container-group && adduser -S container-user -G container-group
+
+USER container-user
+
+COPY --from=buildStage /app/dist/ /app/
+COPY --from=buildStage /app/node_modules/ /app/node_modules
+
+CMD [ "node", "src/index.js" ]

src/index.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2021  Thiago Lopes da Silva
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { v4 } from "uuid";
+
+export class Index {
+  main(): void {
+    console.log("The method main() was called.");
+    console.log("calling the uuid.v4()")
+    console.log(`Result: ${v4()}`);
+  }
+}
+
+new Index().main();

tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "rootDir": "./",
+    "baseUrl": "./",
+    "outDir": "dist",
+    "moduleResolution": "node",
+    "target": "ES6" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "module": "commonjs" /* Specify what module code is generated. */,
+    "resolveJsonModule": true /* Enable importing .json files */,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+    "strict": true /* Enable all strict type-checking options. */,
+    "alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
+    "noUnusedLocals": true /* Enable error reporting when a local variables aren't read. */,
+    "noUnusedParameters": true /* Raise an error when a function parameter isn't read */,
+    "isolatedModules": false,
+    "sourceMap": true,
+    "jsx": "preserve",
+    "declaration": true,
+    "experimentalDecorators": true /* Enable experimental support for TC39 stage 2 draft decorators. */,
+    "emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
+    "composite": true,
+    "strictPropertyInitialization": false
+  },
+  "include": [
+    "src/**/*.ts",
+    "test/**/*.ts"   
+  ],
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}

yarn.lock

@@ -0,0 +1,18 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@types/uuid@8.3.2":
+  version "8.3.2"
+  resolved "https://registry.yarnpkg.com/@types/uuid/-/uuid-8.3.2.tgz#b7077bdfc866dbb39939029774806f24e95be791"
+  integrity sha512-u40ViizKDmdl5FhOXn9WQbulpigYCaiD5hD4KqR3xyQww6l3+0ND+A9TeFla8tFpqvR+UAkJdYb/8jdaQG4/nw==
+
+typescript@4.4.3:
+  version "4.4.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.4.3.tgz#bdc5407caa2b109efd4f82fe130656f977a29324"
+  integrity sha512-4xfscpisVgqqDfPaJo5vkd+Qd/ItkoagnHpufr+i2QCHBsNYp+G7UAoyFl8aPtx879u38wPV65rZ8qbGZijalA==
+
+uuid@8.3.2:
+  version "8.3.2"
+  resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2"
+  integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==