Skip to content

Latest commit

 

History

History
145 lines (125 loc) · 7.21 KB

README.md

File metadata and controls

145 lines (125 loc) · 7.21 KB

License: MIT Stars GitHub contributors 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: Firebase
  • 🎨 Prototipação: Figma
  • 📋 Linguagens: TypeScript HTML CSS3
  • 🖼️ Framework Web: ReactJs

🗃️ Documentação

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

StoryMap

Miro

🎬 Execução

Pré-Requisitos

Configuração do Firebase

Criar Novo projeto

  1. Logue-se no Fire Base com o seu email
  2. Clique em Go to console no header da página para entrar na página de desenvolvimento
  3. 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

  1. Dentro da página do projeto navegue até Criação > Authentication
  2. Clique no botão Vamos começar
  3. Em Authentication > Métodos de login selecione a opção "E-mail/senha" da aba de Provedores nativos
  4. 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

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

Armazenamento de Fotos

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

Aplicativo

  1. Dentro da página do projeto navegue até Configuracoes do projeto > Geral que pode ser acessada pela engrenagem no canto superior esquerdo da sidebar
  2. Abaixo de "Seus aplicativos" clique no icone </> (aplicativo web)
  3. De um nome ao seu aplicativo
  4. 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

👥 Desenvolvedores