Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leo-henrique/containerized-app-with-docker
Aplicação conteinerizada com o Docker.
https://github.com/leo-henrique/containerized-app-with-docker
alpine-linux containers docker docker-compose docker-image dockerfile multi-stage-build
Last synced: about 1 month ago
JSON representation
Aplicação conteinerizada com o Docker.
- Host: GitHub
- URL: https://github.com/leo-henrique/containerized-app-with-docker
- Owner: Leo-Henrique
- Created: 2024-10-24T16:02:54.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T21:30:48.000Z (3 months ago)
- Last Synced: 2024-12-17T00:13:39.783Z (about 1 month ago)
- Topics: alpine-linux, containers, docker, docker-compose, docker-image, dockerfile, multi-stage-build
- Language: TypeScript
- Homepage:
- Size: 266 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Aplicação conteinerizada com Docker
Aplicação de exemplo para demonstrar a conteinerização com o Docker.
## Binário da aplicação
O binário da aplicação — um back-end em Node.js — utiliza uma [imagem oficial do Node.js pelo Docker](https://hub.docker.com/_/node) e conta com algumas abordagens para manter um binário otimizado (contendo atualmente **167MB**).
### Distro Alpine
O primeiro passo visando a construção de um binário otimizado foi escolher uma versão de imagem do Node.js enxuta e que não contém recursos que sequer são utilizados. As versões Alpine tem origem da [distro Alpine do Linux](https://alpinelinux.org/) e possuem exatamente esse propósito.
Eu escolhi a [20.18-alpine](https://hub.docker.com/layers/library/node/20.18-alpine/images/sha256-d504f23acdda979406cf3bdbff0dff7933e5c4ec183dda404ed24286c6125e60?context=explore) que contém apenas **45.42 MB**. Eu também abri mão das versões mais recentes para evitar qualquer possível vulnerabilidade.
### Multi-stage build
Além do meu back-end em Node.js com TypeScript precisar ser compilado para JavaScript, eu também tenho muitas dependências de desenvolvimento que não fazem diferença alguma em produção.
A estratégia de utilizar múltiplos estágios na construção da imagem no Dockerfile foi fundamental para que eu pudesse resolver esse problema e manter um binário leve.
`./Dockerfile`
```Dockerfile
FROM base AS prod-deps
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --prod --frozen-lockfile --ignore-scripts
FROM base AS build
RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install --frozen-lockfile --ignore-scripts
RUN pnpm build
FROM base
WORKDIR /usr/src/app
# Copia somente as dependências de produção para a imagem, instaladas no estágio 'prod-deps'
COPY --from=prod-deps /usr/src/app/node_modules ./node_modules
# Copia os arquivos da aplicação para a imagem, construídas no estágio 'build'
COPY --from=build /usr/src/app/dist ./dist
EXPOSE $API_PORT
CMD ["pnpm", "start"]
```
## Rode localmente
### Dependências globais
Você precisa ter uma principal dependência instalada:
- [Docker](https://www.docker.com/products/docker-desktop/) 24.0.6 (ou qualquer versão superior)
### Clone o projeto
```bash
# git
git clone https://github.com/Leo-Henrique/containerized-app-with-docker.git
# GitHub CLI
gh repo clone Leo-Henrique/containerized-app-with-docker
```
### Suba os containers do Docker
Dois serviços serão iniciados. Um container conterá um servidor Node.js que usa [node:20.18-alpine](https://hub.docker.com/layers/library/node/20.18-alpine/images/sha256-d504f23acdda979406cf3bdbff0dff7933e5c4ec183dda404ed24286c6125e60?context=explore) como imagem base e outro conterá um banco de dados Postgres que usa [postgres:16-alpine3.18](https://hub.docker.com/layers/library/postgres/16-alpine3.18/images/sha256-79790a9fa3ab75f5f590766d095fdd21cf292f1abbaa834bfe2036585ed0f2e5?context=explore) como imagem base.
```bash
docker compose up -d --build
```
### Verificar logs do container da API
```bash
docker compose logs api
```
Se tudo estiver funcionando, você verá nas últimas linhas dos logs uma mensagem assim:
```bash
containerized-app-with-docker-api | Application "containerized-app-with-docker" is running!
containerized-app-with-docker-api | http://localhost:3333/docs
```
Como mostra a mensagem, você conseguirá acessar a documentação da API em: [http://localhost:3333/docs](http://localhost:3333/docs), um servidor em Node.js, sem o próprio Node.js instalado na sua máquina propriamente dita, mas sim, no container (um processo totalmente isolado)!
**OBS**: Se você já subiu serviços do Docker na sua máquina, talvez seja necessário trocar os endereços e portas que estão sendo mapeados. Você pode alterar as variáveis no arquivo `.env` localizado na raiz do projeto e deve subir os serviços novamente para aplicar as alterações.