Skip to content

Repository files navigation

🧠 Sinapse

Organize requisitos. Centralize conhecimento. Desenvolva com contexto.

O Sinapse é uma plataforma para organização e gerenciamento de requisitos de software, desenvolvida pelo Grupo Galáticos para a PRO4TECH.

A aplicação permite estruturar projetos em Épicos, Features e PBIs, acompanhar a qualidade dos requisitos e centralizar informações importantes, como documentos e decisões.


Status Fatec Projeto


🚀 Sobre o projeto

Em um projeto de software, requisitos, decisões e documentos podem acabar espalhados por diferentes ferramentas.

O Sinapse foi desenvolvido para centralizar essas informações e facilitar o trabalho entre Product Owners e equipes de desenvolvimento.

A organização dos requisitos segue uma estrutura hierárquica:

📁 Projeto
 └── 📦 Épico
      └── 🔹 Feature
           └── 📋 PBI
                └── ✅ Critérios de Aceitação

Essa estrutura permite acompanhar um requisito desde sua definição até seus critérios de aceitação e validação.


🎯 Sprint 1

A primeira sprint teve como objetivo construir a base funcional do Sinapse e implementar os principais recursos relacionados ao gerenciamento de projetos e requisitos.

✅ Principais entregas

Entrega Status
📁 Projetos ✅
📦 Épicos, Features e PBIs ✅
🔐 Autenticação ✅
👥 Controle de acesso por perfil ✅
📋 Critérios de aceitação ✅
🧪 Validação da qualidade dos requisitos ✅
💡 Registro de decisões ✅
📄 Documentos ✅
🔎 Busca no backlog ✅
💬 Estrutura de conversas ✅
🤖 Integração com recursos de IA ✅
🧪 Testes automatizados ✅

Sprint 1: 07/09/2026 → 27/09/2026

📌 Planejamento completo da Sprint


🖥️ Conheça o Sinapse

O sistema possui uma interface voltada para a navegação entre projetos e seus respectivos requisitos.

Fluxo principal

Fluxo do Sinapse

Projeto → Backlog → PBI → Qualidade do requisito

📸 Algumas telas

Lista de projetos Visão geral do projeto



Backlog hierárquico Qualidade do PBI

🛠️ Tecnologias

O Sinapse utiliza uma arquitetura baseada em aplicações web, API REST, banco de dados relacional e serviços de IA.

🎨 Frontend

React TypeScript Vite

  • React 19 — construção da interface
  • TypeScript — tipagem e desenvolvimento
  • Vite — build e ambiente de desenvolvimento
  • Vitest — testes
  • Testing Library — testes de interface
  • Lucide React — ícones

⚙️ Backend

Node.js Express TypeScript

  • Node.js 20
  • Express
  • TypeScript
  • API REST
  • Autenticação e autorização
  • Regras de negócio

🗄️ Banco de dados

PostgreSQL

  • PostgreSQL 16
  • pgvector
  • Migrations
  • Seeds

🤖 Inteligência Artificial

Python FastAPI

  • Python
  • FastAPI
  • Ollama
  • Embeddings
  • RAG
  • Análise de repositórios

🔧 Infraestrutura e ferramentas

Docker Nginx GitHub Actions Git

  • Docker / Docker Compose
  • Nginx
  • GitHub Actions
  • n8n
  • Git

🏗️ Arquitetura

A aplicação é organizada em diferentes serviços:

flowchart LR
    U["👤 Usuário"]

    F["🎨 Frontend<br/>React + Vite"]
    B["⚙️ Backend<br/>Node.js + Express"]
    DB[("🗄️ PostgreSQL<br/>+ pgvector")]
    AI["🤖 AI Service<br/>FastAPI"]
    O["🧠 Ollama"]

    U --> F
    F --> B
    B --> DB
    B --> AI
    AI --> O
Loading

Componentes

Componente Tecnologia Função
🎨 Frontend React + TypeScript + Vite Interface da aplicação
⚙️ Backend Node.js + Express API e regras de negócio
🗄️ Banco PostgreSQL + pgvector Persistência dos dados
🤖 AI Service Python + FastAPI Recursos de IA
🧠 Modelos Ollama Inferência local
🔄 Automação n8n Integrações e workflows

🔐 Funcionalidades

📁 Projetos e Backlog

Organização dos requisitos através da hierarquia:

Projeto → Épico → Feature → PBI


🧪 Qualidade dos requisitos

Os PBIs possuem verificações relacionadas à qualidade do requisito, incluindo:

  • estrutura da história;
  • critérios de aceitação;
  • cenários DADO / QUANDO / ENTÃO;
  • identificação de termos vagos;
  • necessidade de protótipo.

As verificações são baseadas em regras determinísticas.


💡 Decisões

Permite registrar decisões relacionadas aos elementos do projeto, mantendo o contexto e a justificativa das escolhas realizadas.


📄 Documentos

Documentos podem ser associados aos projetos e posteriormente consultados ou removidos.


👥 Usuários e permissões

O sistema possui diferentes perfis:

🔴 admin
🟡 po
🔵 dev

Cada perfil possui permissões específicas dentro da aplicação.


🔎 Busca e conversas

O Sinapse permite localizar informações do backlog e manter conversas relacionadas ao projeto.

A arquitetura também permite a integração com recursos de IA para consultas e recuperação de informações.


▶️ Como executar

📋 Pré-requisitos

  • 🐳 Docker Desktop
  • Git
  • Docker Compose v2

Para executar os serviços diretamente no sistema:

  • Node.js 20+
  • Python 3.11+

1️⃣ Clone o repositório

git clone https://github.com/Galaticos-API/API-4.git
cd API-4

2️⃣ Configure o ambiente

Linux / macOS

cp .env.example .env

Windows PowerShell

Copy-Item .env.example .env

3️⃣ Inicie o projeto

docker compose up --build -d

Verifique os containers:

docker compose ps

🌐 Acessos

Serviço Endereço
🧠 Sinapse http://localhost:5173
⚙️ API http://localhost:3001
❤️ Health Check http://localhost:3001/health
📚 Swagger http://localhost:3001/docs
🔄 n8n http://localhost:5678

🧪 Testes

O projeto possui testes automatizados para diferentes partes da aplicação.

Backend

cd backend
npm test

Frontend

cd frontend
npm test

E2E

cd e2e
npm test

Build

Frontend:

cd frontend
npm run build

Backend:

cd backend
npm run build

📂 Estrutura do projeto

.
├── .github/
│   └── workflows/       # CI e automações
│
├── ai-service/          # 🤖 Serviço de IA
├── backend/             # ⚙️ API e regras de negócio
├── database/            # 🗄️ Banco, migrations e seeds
├── docs/                # 📚 Documentação
├── e2e/                 # 🧪 Testes End-to-End
├── figma-import/        # 🎨 UX e protótipos
├── frontend/            # 🖥️ Aplicação React
└── n8n/                 # 🔄 Workflows

👥 Equipe

Função Integrante GitHub
🎯 Product Owner Daniel Dias @DanielDPereira
🧭 Scrum Master Cauan Gabriel @LoadCG
💻 Development Team Emmanuel Garakis @Garakis
💻 Development Team Rafael Matesco @RafaMatesco
💻 Development Team Gustavo Bueno @Darkghostly
💻 Development Team Gabriel Lasaro @GaelNotFound
💻 Development Team Giovanni @Giomoret
💻 Development Team Heitor @heitors1337
💻 Development Team Vitor @vitorpdim

📚 Documentação

Para informações mais específicas:

Documento Conteúdo
📋 Planejamento Scrum Sprints e planejamento
📚 Documentação Índice dos documentos
⚙️ Setup Configuração do ambiente
🏗️ Arquitetura Arquitetura do sistema
🔌 OpenAPI Contrato da API
📋 PRD Requisitos do produto
🗂️ Backlog Épicos e PBIs

🎓 Contexto acadêmico

O Sinapse é um Projeto de Aprendizagem Interdisciplinar (API) desenvolvido pelo Grupo Galáticos, no 4º semestre do curso de Análise e Desenvolvimento de Sistemas da Fatec São José dos Campos, para a empresa parceira PRO4TECH.


🧠 Sinapse

Grupo Galáticos · Fatec São José dos Campos · 2026

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages