Skip to content

Guardians-DSC/Front-HoCo

Repository files navigation

🕒 O HoCo

❔ O que é o HoCo


Olá! Bem-vinde ao HoCo. O HoCo é uma plataforma que conta com o objetivo inicial de prover aos alunos da graduação de Ciência da Computação na UFCG uma maneira simples e facilitada de gerenciar suas horas complementares obrigatórias para a conclusão do curso..

🎯 Objetivo

O pouco conhecimento sobre como adquirir e gerenciar horas e atividades complementares durante a graduação é um fato conhecido de longa data pelos alunos da graduação em Ciência da Computação na UFCG. Pensando nisso, nasce o HoCo.

O projeto tem como objetivo sanar a deficiência de gerenciamento das horas complementares do curso, provendo uma ferramenta onde os graduandos gerenciem as horas complementares, tendo o conhecimento do funcionamento, normas atuais do curso, e assim melhorando a gestão do seu tempo de atividades extracurriculares ao longo da faculdade.


📋 Índice

⚙️ Pré-requisitos

Para executar o projeto é necessário ter instalado na sua máquina o docker, o ambiente de implementação do projeto, e o docker-compose, a ferramenta de auxílio no gerenciamento do ambiente de docker. Para auxílio, abaixo estão listados alguns links úteis para a instalação dessas dependências:

🏃 Como executar o projeto

⚠️ ATENÇÃO: É necessário se atentar ao fato que este projeto é o front-end do Projeto HoCo. Assim, caso você necessite da execução completa, é necessário executar o back-end do projeto. O passo-a-passo a seguir, se limita a execução do front-end do projeto, abrangendo apenas as funcionalidades implementadas que não possuem a necessidade da execução do back-end.

Siga os seguintes passos para a execução do projeto:

  1. Faça o clone do projeto e seus submódulos: front-end e back-end:
  git clone https://github.com/Guardians-DSC/Front-HoCo
  1. Entre na pasta do projeto:
  cd Front-HoCo
  1. Instale as dependências
  npm install
  1. Por fim, execute o projeto
  npm start

Pronto! Com esses comandos simples você já conseguirá executar localmente o projeto. No caso de modificação do código-fonte, o projeto irá atualizar automaticamente.

🤝 Como contribuir

Caso esteja interessade(o/a) em contribuir com algum dos projetos do HoCo, verifique as issues de cada projeto. Caso encontre uma issue interessante e deseje contribuir, primeiramente leia os documentos do Código de conduta e Contribuindo para saber mais detalhes.

⚠️ O projeto ainda se encontra em desenvolvimento, caso você queira acompanhar o avanço do repositório dê um estrelinha ⭐ para não perder as atualizações do repo.

📌 Mantenedores

✏️ Licença e Copyright

MIT © Licença


No mais é isso! Obrigado por ler até aqui, esperamos que tenha gostado do projeto!