Tupã

Tip

Este repositório é dedicado ao projeto "Tupã", um sistema desenvolvido para a coleta e análise de dados meteorológicos. Ele abrange tanto a montagem quanto a configuração de uma estação meteorológica equipada com diversos sensores, além de um sistema que processa e interpreta os dados enviados pela estação. Esses dados podem ser analisados em gráficos e tabelas, com suporte para visualização em dispositivos desktop, web e mobile. Em especial, este repositório em questão, é destinado à toda a parte Front-End da aplicação.

Note

Aplicação desenvolvida pela equipe: SyntaxSquad, composta por alunos do 4º semestre, do tecnólogo em Desenvolvimento de Software Multiplataforma, na FATEC Profº Jessen Vidal - São José dos Campos, SP, 2024 🚀

---

🛠️ Tecnologias

As seguintes tecnologias e ferramentas foram utilizadas no Front-End:

---

❓ Como rodar ❓

Warning

É preciso ter o Node instalado em sua máquina!

O projeto foi desenvolvido no Node v22.7.0, portanto recomendamos utilizar entre a versão 18 e 22, pois garantimos que haverá suporte.

É possível rodar localmente o projeto, seguindo o passo a passo abaixo, utilize estes comandos em um terminal:

Note

Este exemplo é para utilização com Npm

# Baixe ou clone este repositório
$ git clone https://github.com/Grupo-Syntax-Squad/Tupan.git

# Acesse a pasta, instale as dependências e inicie o projeto
$ cd Tupan-Front

# caso queira intalar o husky:
$ npm i

# se não quiser o husky, continue daqui:
$ cd tupan
$ npm i
$ npm run dev

A aplicação inciará localmente na porta 3000. Use o navegador para acessar o link http://localhost:3000 e executar as funcionalidades da aplicação.

---

🗃️ Estrutura de Diretórios

Diretório	Descrição
📂 .husky/	Arquivos de configuração para validação das mensagens de commit elaboradas como padrão
📂 tupan/	Diretório principal do projeto, abrangendo as dependências, código fonte e arquivos de mídia
📂 tupan/public/assets	Arquivos visuais (imagens, ícones, fontes...)
📂 tupan/src	Código fonte do projeto.
📂 tupan/src/app	Todas as páginas do projeto e comunicação com serviços externos.
📂 tupan/src/app/_api	Requests de serviços (servidor-backend e API) via métodos: get, post, delete e update.
📂 tupan/src/components	Componentes do projeto (botões, rodapés, formulários, barra de navegação..)
📂 tupan/src/hooks	Diretório para armazenar hooks do projeto.
📂 tupan/src/styles	Arquivos de estilização adicionais.
📂 tupan/src/test	Arquivos de testes TDD.
📂 tupan/src/types	Arquivos de interface e ou tipagem de componentes e atributos.
📄 package.json	Arquivo usado para gerenciar as dependências do husky, scripts e versões.
📄 tupan/jest.config.ts	Arquivo para configuração do framework de testes: jest.
📄 tupan/package.json	Arquivo usado para gerenciar as dependências do projeto, scripts e versões.
📄 tupan/next.config.mjs	Arquivo para configuração do framework de React: NextJS.
📄 tupan/tailwind.config.ts	Arquivo para configuração do framework de CSS: tailwind.

---

🌟 Releases

TAG	Descrição	Sprint
1.0.0	Criação das páginas e integração dos CRUD's de todos os elementos (parâmetros, usuários, estaçõoes e alertas)	1