README.md

tuvens

📆 Organizando nossa presença física durante a COVID-19

O que é o tuvens?

O tuvens é um projeto que pretende ajudar a regular a quantidade de pessoas em ambientes comuns na UFCG, como laboratórios e salas de aula, permitindo o agendamento de presença, além de limitar a quantidade de pessoas por sala e permitir a visualização de métricas úteis para responder perguntas como: “Hoje é um bom dia para ir lá?” ou “Qual dia da semana tem menor ocupação”.

Desenvolvimento

Clonando o repositório

Caso deseje fazer alterações no código, você pode executar o projeto localmente. Recomendamos que você faça um Fork do repositório e o Clone para sua máquina:

git clone https://github.com/<seu_usuario>/tuvens.git

Substitua <seu_usuario> pelo seu usuário do github.

cd tuvens

Instalando as Dependências

Depois disso, entre no repositório clonado e utilize yarn ou npm para baixar as dependências e rodar o projeto.

yarn install

ou

npm install

Executando o Projeto

Uma vez instaladas as dependências, para executar o projeto em modo de desenvolvimento você só precisa executar um dos seguintes comandos:

yarn start

ou

npm start

Agora é só começar a fazer as mudanças e você verá as alteraçes em seu navegador!

Como Contribuir

Veja nosso CONTRIBUTING e o Código de Conduta.

Licença

MIT License