Pronto para usar
Keycloak integrado
Padrão de módulos
Boas práticas

Starter Kits CInCoders

As mesmas bases que usamos nos sistemas do CIn, abertas para quem quer começar um projeto novo: backend em NestJS e frontend em React, já integrados ao Keycloak e documentados.

Frontend + backend em um comando

$curl -fsSL https://gitlab.cin.ufpe.br/cincoders/platform/boilerplate/-/raw/main/setup.sh | bash

Cria <nome>-back e <nome>-front lado a lado, com nome, URLs e realm do Keycloak já alinhados entre os dois.

Escolha seu ponto de partida

Cada kit gera um repositório novo e independente, com a estrutura, as ferramentas e as convenções que a equipe já usa no dia a dia.

NestJS StarterKit

Backend

Base modular para microsserviços e APIs REST em Node.js com TypeScript, com autenticação, validação, persistência e documentação OpenAPI já configuradas.

  • NestJS 11
  • Prisma 5
  • PostgreSQL
  • Keycloak + jose
  • Zod
  • Swagger
  • Vitest
  • Biome
  • Validação de JWT do Keycloak via JWKS, com política fail-closed
  • Um schema Zod para validação, tipagem e OpenAPI
  • Migrations com Prisma e seeds das tabelas de apoio
  • Swagger interativo em /api/docs
Só o backend
$curl -fsSL https://gitlab.cin.ufpe.br/cincoders/platform/cincoders-nestjs-boilerplate/-/raw/main/setup.sh | bash

ReactJS StarterKit

Frontend

Base para aplicações frontend em React com TypeScript, integrada ao Keycloak (OIDC) e ao padrão de módulos usado nos projetos do CIn.

  • React 18
  • Vite 7
  • react-router 7
  • Cinnamon
  • Keycloak (OIDC)
  • Tailwind CSS 4
  • Zod
  • Vitest
  • Login, sessão e refresh de token com react-oidc-context
  • Controle de acesso (RBAC) em dois níveis
  • Layout, tabelas e telas de erro padronizadas com a Cinnamon
  • Módulos de exemplo para copiar e adaptar
Só o frontend
$curl -fsSL https://gitlab.cin.ufpe.br/cincoders/platform/cincoders-reactjs-boilerplate/-/raw/main/setup.sh | bash

O que já vem pronto

Você começa pelo que é do seu projeto, não pela configuração.

Autenticação com Keycloak

Login OIDC no frontend e validação de JWT no backend, com um realm local pré-configurado para desenvolvimento.

Validação com Zod

Um único schema define a validação, a tipagem e, no backend, a documentação OpenAPI.

Padrão de módulos

Cada domínio vira um módulo isolado, com guias passo a passo e exemplos para copiar.

Testes desde o início

Vitest configurado para testes unitários, de componente e de integração.

Qualidade no commit

Lint, formatação e Conventional Commits verificados automaticamente antes de cada commit.

Release automatizado

Versionamento, changelog e deploy pela pipeline padrão da fábrica no GitLab.

Como começar

Nunca trabalhou com essas tecnologias? Cada documentação traz uma leitura inicial, na ordem certa para aprender.

  1. 01

    Prepare o ambiente

    Node.js 24 LTS, Docker com Docker Compose e Git. No Windows, rode os comandos pelo Git Bash: o setup usa utilitários POSIX.

  2. 02

    Gere o projeto

    Rode o comando do setup na pasta onde quer o projeto. O assistente pergunta nome, descrição e remote, e cria um repositório novo com tudo no lugar.

  3. 03

    Suba e desenvolva

    Suba banco e Keycloak com docker compose e inicie em modo de desenvolvimento. A documentação de cada kit explica arquitetura, módulos e testes.