{"id":50861151,"url":"https://github.com/webtech-network/lab-cicd","last_synced_at":"2026-06-14T21:34:44.261Z","repository":{"id":356595304,"uuid":"1232198596","full_name":"webtech-network/lab-cicd","owner":"webtech-network","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-08T19:03:52.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-08T20:42:15.198Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webtech-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-07T17:29:45.000Z","updated_at":"2026-05-08T19:03:57.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/webtech-network/lab-cicd","commit_stats":null,"previous_names":["webtech-network/lab-cicd"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/webtech-network/lab-cicd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtech-network%2Flab-cicd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtech-network%2Flab-cicd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtech-network%2Flab-cicd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtech-network%2Flab-cicd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webtech-network","download_url":"https://codeload.github.com/webtech-network/lab-cicd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webtech-network%2Flab-cicd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34339195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-14T02:00:07.365Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-14T21:34:40.393Z","updated_at":"2026-06-14T21:34:44.255Z","avatar_url":"https://github.com/webtech-network.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# 🚀 Lab CI/CD — Node.js + Prisma + Docker\n\n[![CI Pipeline](https://github.com/webtech-network/lab-cicd/actions/workflows/ci.yml/badge.svg)](https://github.com/webtech-network/lab-cicd/actions)\n[![Node.js Version](https://img.shields.io/badge/Node.js-20.x-green.svg)](https://nodejs.org/)\n[![Prisma ORM](https://img.shields.io/badge/Prisma-5.0-blue.svg)](https://www.prisma.io/)\n[![Docker](https://img.shields.io/badge/Docker-Ready-2496ED.svg?logo=docker)](https://www.docker.com/)\n\n\u003e Laboratório prático e avançado de CI/CD com GitHub Actions, englobando análise de código (linting), testes automatizados, build e preparação de imagens Docker.\n\n---\n\n## 📖 Sobre o Projeto\n\nEste repositório serve como um laboratório completo para demonstrar uma esteira (pipeline) de CI/CD moderna. A aplicação base é uma API construída em **Node.js** com o framework **Express**, utilizando **Prisma ORM** para gestão do banco de dados (SQLite) e empacotada com **Docker**.\n\nO foco principal é a **automatização da qualidade e entrega de software**: desde a verificação do estilo de código e execução de testes unitários até à construção da imagem do contentor.\n\n---\n\n## 🛠️ Stack Tecnológica\n\n| Tecnologia | Função no Projeto |\n| :--- | :--- |\n| 🟢 **Node.js 20** | Ambiente de execução da aplicação (Runtime) |\n| 🚂 **Express** | Framework web para a criação de rotas HTTP |\n| 🗄️ **Prisma ORM** | Modelagem e comunicação com o banco de dados SQLite |\n| 🃏 **Jest + Supertest** | Criação e execução de testes automatizados de integração |\n| 🔍 **ESLint** | Análise estática e padronização do código-fonte |\n| 🐳 **Docker** | Containerização da aplicação para garantir portabilidade |\n| 🐙 **GitHub Actions** | Orquestração da pipeline de Integração e Entrega Contínuas |\n\n---\n\n## 📡 Referência da API\n\nA aplicação expõe os seguintes endpoints:\n\n### `GET /status`\nVerifica a saúde da API e o status da integração.\n* **Resposta de Sucesso (200 OK):**\n  ```json\n  {\n    \"status\": \"API Online e CI/CD configurado!\"\n  }\n\n```\n\n### `GET /users`\n\nRetorna a lista de utilizadores registados na base de dados.\n\n* **Resposta de Sucesso (200 OK):**\n```json\n[\n  {\n    \"id\": 1,\n    \"name\": \"Alice\",\n    \"email\": \"alice@example.com\"\n  }\n]\n\n```\n\n\n\n---\n\n## ⚙️ Como Executar Localmente\n\n### Pré-requisitos\n\n* **Node.js** (versão 20 ou superior)\n* **Git**\n* **Docker** (opcional, caso pretenda correr o contentor)\n\n### Passos para Instalação\n\n1. **Clone o repositório:**\n```bash\ngit clone [https://github.com/webtech-network/lab-cicd.git](https://github.com/webtech-network/lab-cicd.git)\ncd lab-cicd\n\n```\n\n\n2. **Instale as dependências:**\n```bash\nnpm install\n\n```\n\n\n3. **Gere o Prisma Client e crie a base de dados SQLite:**\n```bash\nnpx prisma generate\nnpx prisma db push\n\n```\n\n\n4. **Inicie o servidor:**\n```bash\nnpm run dev\n\n```\n\n\n\u003e A API estará disponível em: `http://localhost:3000`\n\n\n\n### Comandos Úteis (Scripts)\n\n* `npm start` ou `npm run dev`: Inicia a aplicação.\n* `npm test`: Executa a suite de testes com o Jest.\n* `npm run lint`: Verifica possíveis erros e formatação no código fonte usando ESLint.\n\n---\n\n## 🐳 Execução com Docker\n\nSe preferir não instalar o Node.js na sua máquina, pode correr o projeto inteiramente via Docker:\n\n1. **Construir a imagem da aplicação:**\n```bash\ndocker build -t lab-cicd:latest .\n\n```\n\n\n2. **Executar o contentor:**\n```bash\ndocker run -p 3000:3000 lab-cicd:latest\n\n```\n\n\n\n---\n\n## 🔄 Arquitetura da Pipeline CI/CD (GitHub Actions)\n\nA nossa pipeline (`.github/workflows/ci.yml`) é acionada automaticamente sempre que ocorre um `push` ou `pull_request` para a branch `main`.\n\nOs *jobs* são executados de forma estruturada:\n\n```mermaid\ngraph TD;\n    A[Push / PR na main] --\u003e B(Lint: ESLint);\n    B --\u003e C(Test: Jest);\n    C --\u003e D(Build: Docker Image);\n\n```\n\n1. **Lint (`npm run lint`)**: Verifica se o código cumpre as boas práticas definidas no `.eslintrc.json`.\n2. **Test (`npm test`)**: Necessita que o *Lint* seja aprovado. Executa os testes de integração do Express com Jest/Supertest.\n3. **Build (`docker build`)**: Necessita que os *Testes* passem. Constrói a imagem Docker baseada na versão testada do código (nesta fase do lab, a publicação no *registry* está desativada).\n\n---\n\n## 📁 Estrutura de Diretórios\n\n```text\nlab-cicd/\n├── .github/workflows/   # Configurações do GitHub Actions (ci.yml)\n├── prisma/              # Schema do banco de dados e ficheiro SQLite\n├── src/                 # Código-fonte principal da aplicação\n│   ├── app.js           # Configuração do Express e rotas\n│   ├── server.js        # Ponto de entrada (inicia o servidor HTTP)\n│   └── userService.js   # Regras de negócio e chamadas ao Prisma\n├── tests/               # Testes automatizados (Jest + Supertest)\n├── .eslintrc.json       # Configuração das regras do ESLint\n├── Dockerfile           # Instruções para construir a imagem Docker\n└── package.json         # Dependências e scripts do projeto\n\n```\n\n---\n\n*Desenvolvido para o evento de comemoração de 10 anos do curso de Engenharia de Software.*\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebtech-network%2Flab-cicd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebtech-network%2Flab-cicd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebtech-network%2Flab-cicd/lists"}