Repositório
- Hospedagem
- GitHub — github.com/SLAYERDLLBR/eraso
- Visibilidade
- Público
- Licença do código do ERASÓ
- Apache License 2.0 (arquivo
LICENSEno repositório). O nome, o logotipo e o símbolo não estão incluídos na licença. - Contribuições
- As regras estarão no arquivo
CONTRIBUTING.mddo repositório. Enquanto isso, envie sugestões pelo Contato
O que há no projeto
app/ Aplicativo web (HTML, CSS e JavaScript puros)
server/ Servidor de presença e sinalização; também serve o site e o aplicativo
landing/ Site e páginas institucionais
tests/ Testes automatizados (servidor, rede, interface e ponta a ponta)
docs/ Design system, relatórios de testes, guia de hospedagem e documentos de produção
O projeto não tem banco de dados, contas de usuário nem etapa de compilação, e não usa dependências externas: o navegador roda HTML, CSS e JavaScript puros, e o servidor usa apenas módulos nativos do Node.js.
Como executar
É preciso o Node.js 18 ou superior. Na pasta raiz do projeto:
npm start
O terminal mostra os endereços da sua rede, como http://192.168.0.12:8780/app/index.html. Abra o mesmo endereço em cada aparelho, no mesmo Wi-Fi. O site fica em /landing/index.html.
Para o modo público (internet, com salas e limites), use npm run start:publico atrás de HTTPS. As variáveis de ambiente e o passo a passo de hospedagem estão em docs/etapa4/HOSPEDAGEM.md. As fontes vêm do Google Fonts e precisam de internet.
Como testar
npm test
Executa quatro suítes: servidor (salas, autenticação, limites, cabeçalhos e pastas servidas), camada de rede, interface com dois navegadores reais e ponta a ponta no modo público. Exigem o Microsoft Edge (ou outro Chromium, definido na variável EDGE). Para conferir os links do site: npm run verificar-site.
Para regenerar as páginas institucionais depois de editar o conteúdo em landing/tools/paginas/: node landing/tools/gerar-paginas.mjs.
Documentos técnicos
Ficam na pasta docs/ do repositório:
- Design system (
docs/design/DESIGN_SYSTEM.md): conceito, princípios, identidade, cores, tipografia e acessibilidade. - Tokens de design (
DESIGN_TOKENS.md) e especificação de movimento (MOTION_SPEC.md). - Inventário de componentes (
COMPONENT_INVENTORY.md) e plano de adaptação (ADAPTATION_PLAN.md, análise do LocalSend). Parte desses documentos foi escrita antes da implementação real e ainda descreve recursos que o projeto decidiu não construir (pareamento, rota remota). - Relatórios de testes e de correções, e o guia de hospedagem (
docs/etapa3edocs/etapa4).
Licenças e créditos
| Componente | Origem | Licença | Observação |
|---|---|---|---|
| Código do ERASÓ | Equipe do projeto | Apache License 2.0 | Titular dos direitos autorais [a definir]. Textos do site: [licença a definir]. |
| Estrutura, medidas, pontos de quebra e animações da landing | localsend/website | Apache License 2.0 | Adaptados para a identidade do ERASÓ. Atribuição no rodapé, no início de landing/styles.css e em landing/THIRD_PARTY_NOTICES.md. |
| Aplicativo LocalSend | localsend/localsend | Apache License 2.0 | Apenas referência funcional; nenhum código incorporado. |
| Fontes Instrument Sans, Lexend e IBM Plex Mono | Google Fonts | SIL Open Font License 1.1 | Carregadas do Google Fonts (veja Privacidade). |
| Ícones | Equipe do projeto | [a definir] | Ícones de traço desenhados para o projeto. |
| Logotipo e símbolo ERASÓ | Equipe do projeto | [direitos a definir] | O símbolo vetorial atual é provisório, recriado a partir do PNG oficial; falta o SVG oficial. |
Como contribuir
As regras de contribuição acompanham o repositório (CONTRIBUTING.md); contribuições são licenciadas sob a Apache License 2.0. Para relatar problemas ou sugerir melhorias, use o Contato; para falhas de segurança, veja Segurança.
Créditos
O ERASÓ agradece aos autores e colaboradores do LocalSend, cuja organização funcional serviu de referência, e aos criadores das fontes usadas. A equipe do ERASÓ será listada em Projeto acadêmico quando for informada.