Documentação do

Documentação técnica do ecossistema RoboStage — arquitetura, funcionalidades, APIs e desenvolvimento.

Acessar plataforma · Repositório GitHub · Releases · Reportar problema

O RoboStage é uma plataforma web de código aberto voltada à organização, ao desenvolvimento e à evolução de equipes de robótica educacional.

O projeto integra ferramentas de planejamento estratégico, documentação técnica, testes de robôs, análise de dados, gestão de tarefas e preparação para competições em um único ecossistema.

Seu desenvolvimento é orientado principalmente às necessidades de equipes participantes da FIRST® LEGO® League Challenge (FLLC), com uma arquitetura que permite a evolução contínua de ferramentas e integrações.

Esta documentação descreve como o projeto é organizado, como seus componentes funcionam e como desenvolver, integrar ou contribuir com novas funcionalidades.

Navegação técnica#

Ecossistema#

O RoboStage é composto por módulos especializados que atendem diferentes etapas do trabalho de uma equipe.

Stagebook#

Ambiente de organização e documentação. Centraliza documentos, pastas, tags, ideias, aprendizados e informações compartilhadas entre os integrantes da equipe.

QuickBrick Studio#

Ferramentas para planejamento estratégico, análise de missões, organização de runs e preparação de estratégias para o robô.

LabTest#

Ambiente de experimentação e registro de testes. Permite configurar execuções, armazenar resultados e analisar o desempenho e a consistência do robô.

ThinkLab#

Ferramentas para estruturar processos de pesquisa e desenvolvimento, incluindo organização de ideias, diagramas, evidências e atividades relacionadas ao Projeto de Inovação.

Kanban e Calendário#

Recursos de organização do trabalho, acompanhamento de tarefas, distribuição de responsabilidades e planejamento de eventos da equipe.

ShowLive e ferramentas complementares#

O ecossistema também reúne ferramentas voltadas à gestão de eventos, cronômetros, revisão de conteúdo e simulação de estratégias.

Consulte a documentação das funcionalidades para obter detalhes sobre cada módulo.

Arquitetura e tecnologias#

O RoboStage utiliza uma stack moderna de desenvolvimento web, com organização baseada no Next.js App Router.

A arquitetura separa responsabilidades de interface, lógica de aplicação, persistência de dados e utilitários compartilhados.

Para entender a organização real dos módulos, os fluxos de execução e as integrações, consulte a documentação da arquitetura.

APIs e integrações#

As APIs permitem que diferentes partes da aplicação troquem dados e executem operações de domínio.

A referência técnica deve documentar, para cada endpoint:

• Método HTTP e rota: endereço e operação suportada.
• Autenticação: requisitos de identidade e permissões.
• Parâmetros: dados de rota, query string e corpo da requisição.
• Respostas: estrutura dos dados retornados e códigos HTTP.
• Erros: situações de falha e respectivos formatos de resposta.
• Exemplos: requisições e respostas representativas.

A documentação das APIs deve refletir a implementação real do projeto, incluindo as regras de validação, autorização e persistência.

Consulte: Referência das APIs.

Modelo de desenvolvimento#

O desenvolvimento do RoboStage segue o fluxo habitual de um projeto colaborativo hospedado no GitHub.

1. Interface: componentes React e páginas da aplicação.
2. Lógica de aplicação: validação, regras de negócio e operações de servidor.
3. Persistência: modelos e operações de banco de dados.
4. Integrações: serviços externos e fontes de dados utilizadas pelos módulos.
5. Entrega: alterações versionadas, revisão por pull request e publicação de versões.

Os detalhes de cada camada, bem como os padrões e as convenções efetivamente utilizados, devem ser consultados na documentação da arquitetura e no guia de desenvolvimento.

Executar localmente#

Para contribuir com o código, comece obtendo o repositório:

git clone https://github.com/ohthias/roboStage.git
cd roboStage
npm install

Em seguida, configure as variáveis de ambiente exigidas pelo projeto e execute os scripts disponíveis no package.json.

npm run dev

Por padrão, aplicações Next.js iniciadas por esse comando ficam disponíveis em http://localhost:3000, salvo configuração diferente.

Importante: npm install e npm run dev são os passos iniciais. A configuração de autenticação, banco de dados e outros serviços depende das variáveis e dos recursos exigidos pela versão atual do projeto.

Consulte Instalação e configuração antes de iniciar o ambiente completo.

Contribuir com o projeto#

O RoboStage é um projeto independente, desenvolvido a partir de necessidades reais da comunidade de robótica.

Você pode contribuir por meio de:

• Correção de erros e melhorias de desempenho.
• Desenvolvimento de funcionalidades.
• Melhorias de acessibilidade e experiência de uso.
• Documentação técnica e exemplos de integração.
• Testes, sugestões e relatos de problemas.

Antes de enviar alterações, consulte o Guia de Contribuição e o Código de Conduta.

Projeto em evolução#

O RoboStage evolui continuamente conforme as necessidades das equipes, os resultados dos testes e as contribuições da comunidade.

• Código-fonte
• Issues abertas
• Pull requests
• Versões publicadas
• Histórico de alterações