unb-mds/Squad09-UnBHUB - Githubissues

Stars Stars

UNBHUB - Squad 09

UnbHub

Projeto da disciplina Métodos de Desenvolvimento de Software cujo intuito é auxiliar os alunos da Faculdade do Gama na organização de suas atividades acadêmicas. A página permite ao usuário registrar sua grade e informações específicas de cada matéria, como datas das provas e notas dos trabalhos, ajudando-os a se manterem em dia com cada matéria.

💻 Tecnologias

💾 Banco de Dados:
🎨 Prototipação:
📋 Linguagens:
🖼️ Framework Web:

🗃️ Documentação

Para acessar a página web da nossa documentação Clique aqui

StoryMap

🎬 Execução

Pré-Requisitos

Configuração do Firebase

Criar Novo projeto

Logue-se no Fire Base com o seu email
Clique em Go to console no header da página para entrar na página de desenvolvimento
Crie um novo projeto clicando em + Criar Projeto
- Obs: O uso do Google Analytics fica a critério de quem quiser rodar o projeto não sendo necessário para a sua execução

Autenticação

Dentro da página do projeto navegue até Criação > Authentication
Clique no botão Vamos começar
Em Authentication > Métodos de login selecione a opção "E-mail/senha" da aba de Provedores nativos
Ative o serviço de E-mail/senha
- Obs: Não precisa ativar o serviço de "Link do e-mail(login sem senha)"

Banco de Dados

Dentro da página do projeto navegue até Criação > Firestore Database
Clique no botão Criar banco de dados
Mude o local do servidor para southamerica-east1 (São Paulo) ou para outra região de sua preferência
Inicie o banco de dados na opção modo de teste

Armazenamento de Fotos

Dentro da página do projeto navegue até Criação > Storage
Clique em Começar
Inicie o armazenamento na opção modo de teste

Aplicativo

Dentro da página do projeto navegue até Configuracoes do projeto > Geral que pode ser acessada pela engrenagem no canto superior esquerdo da sidebar
Abaixo de "Seus aplicativos" clique no icone </> (aplicativo web)
De um nome ao seu aplicativo
Marque a opção Usar o npm
- Obs: A opção de hosting fica a critério de quem quiser rodar o projeto

Como Rodar o projeto

Clone o Repositório do projeto
git clone https://github.com/unb-mds/Squad09-UnBHUB.git
Navegue para a pasta do projeto e baixe as dependências com o seguinte comando
yarn
Cadastre os dados do seu aplicativo do FireBase criando um arquivo .env preenchendo-o com as seguintes infomações
VITE_VERCEL_API_KEY=
VITE_VERCEL_AUTH_DOMAIN=
VITE_VERCEL_PROJECT_ID=
VITE_VERCEL_STORAGE_BUCKET=
VITE_VERCEL_MESSAGING_SENDER_ID=
VITE_VERCEL_APP_ID=
Obs: Os dados do cadastro estão localizados em Configuracoes do projeto > Geral na página do projeto do Firebase, devendo ser preenchidos sem as aspas nos seus respectivos campos do arquivo .env

Execute o projeto em local host com o seguinte comando
yarn run dev
Por fim o projeto pode ser acessado em localmente pela porta de acesso exibida no terminal

Ferramenta de WebScraping

Para facilitar o preenchimento dos dados do cardápio do RU e do Calendário Acadêmico foi criada uma ferramenta de web scraping que faz o envio desses dados automaticamente para o firestore database que pode ser encontrada Aqui