Boletim Usefaz

• Docker (com Compose v2)
• Node >= 26 (o pnpm baixa a versão definida em devEngines automaticamente)
• pnpm (corepack enable instala a versão definida em package.json)

Monorepo com pnpm workspaces. As versões compartilhadas ficam no catalog do pnpm-workspace.yaml.

• pnpm install: Instala as dependências do projeto
• Copie o arquivo .env.example do apps/server para .env
• pnpm dev: Inicia os containers do projeto
  • Se a porta 3000 estiver ocupada, use SERVER_PORT=3010 pnpm dev: a API sobe na 3010 e os apps passam a chamá-la lá
• pnpm db:reset: Recria o banco do zero e alimenta com dados de teste (só em desenvolvimento)
• Abra o Sistema de Boletim em http://localhost:8080
  • RM 12345
  • Senha usefaz123
• Abra o Sistema do Administrador em http://localhost:8081
  • E-mail lucasgdbittencourt@gmail.com
  • Senha usefaz123
• pnpm stop: Desliga o projeto.

E-mails (links de redefinição de senha) saem pelo SMTP do Gmail. Para testar sem enviar nada, use MAIL_DRIVER=log no .env do servidor: o e-mail, com o link, aparece no log (docker logs server).

• pnpm lint / pnpm lint:fix: Lint e formatação com Biome
• pnpm typecheck: Gera os artefatos do Relay e checa os tipos de todos os pacotes
• pnpm build: Gera o build de produção de todos os apps

No servidor (pnpm --filter @usefaz/server <script>, ou docker compose exec server pnpm <script>):

• migrate / rollback: Aplica as migrations pendentes / desfaz a última
• db:types: Gera os tipos do Kysely (src/database/types.ts) a partir do banco, depois de uma migration
• db:reset: Recria o banco com os dados de teste (só em desenvolvimento)

• Sessão: cookie httpOnly com um token opaco (só o hash fica no banco), um por app (X-Usefaz-App). Senhas com argon2id.
• GraphQL: só aceita persisted queries em produção. O relay-compiler de cada app grava as operações em apps/server/persisted-operations/; rode pnpm relay depois de mudar uma query ou mutation.
• Erros: falhas que o usuário pode corrigir voltam como dado (error { field userMessage }); veja packages/ui/README.md.
• Uploads: avatares no public/ do servidor (STORAGE_DRIVER=local) ou num bucket S3 (STORAGE_DRIVER=s3 e as variáveis S3_*).

Boletim com notas, faltas e médias	Foto de perfil
Erro do servidor no formulário	Recuperação de senha
Modo offline (PWA) com a última cópia salva	Tema de Natal

Datas comemorativas (Natal, Halloween, Páscoa, Festa Junina, entre outras) decoram o boletim e a foto do aluno. Para ver um tema fora da época, use ?tema=natal (ou ?tema=off para desligar).

Login

Perfil

Boletim

Tema de Natal

@lucasgdb