Skip to content

Latest commit

 

History

History
117 lines (77 loc) · 4.25 KB

README.md

File metadata and controls

117 lines (77 loc) · 4.25 KB
Raw

🕒 O HoCo

❔ O que é o HoCo


Olá! Bem-vinde ao HoCo. O HoCo é uma plataforma com objetivo de prover (inicialmente) aos alunos da graduação de Ciência da Computação na UFCG uma plataforma onde ele/ela pode salvar e gerenciar as suas horas complementares do curso.

🎯 Objetivo

A falta de praticamente qualquer conhecimento sobre horas e atividades complementares do curso é um conhecido de longa data dos alunos da graduação de Ciência da Computação na UFCG e foi pensando nisso que o HoCo nasceu.

O projeto tem como objetivo sanar essa deficiência do curso provendo um lugar onde os alunos além de salvarem suas horas possam ter conhecimento do seu funcionamento e das normas atuais do curso.

📋 Índice

⚙️ Pré-requisitos

Para executar o projeto você precisa ter instalado na sua máquina o docker e docker-compose. Abaixo estão alguns links úteis para a instalação dessas dependências:

🏃 Como executar o projeto

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

  1. Fazer o clone do projeto e dos seus submodulos de frontend e backend
  git clone --recurse-submodules https://github.com/Guardians-DSC/HoCo
  1. Entrar na pasta do projeto
  cd HoCo
  1. Copiar variáveis de ambiente que estão dentro do arquivo .env.example
  cp .env.example .env
  1. Atualizar submodulos do repositório
  git submodule update --remote --recursive
  1. Instale as dependencias do frontend
  cd frontend
  npm i
  1. Executar o arquivo docker-compose.yml na raiz do projeto
  cd ..
  docker-compose up

⚠️ ATENÇÂO: Se o comando acima acarretou em um erro de permissão, então você precisa criar um grupo docker, para isso veja o link a seguir: Link para rodar o docker-compose up sem sudo criando um grupo

Pronto! Simples assim e você já consegui executar localmente o projeto, caso você esteja executando o projeto e modificar alguma coisa no código o projeto será atualizado automaticamente.

🤝 Como contribuir

Caso você esteja interessada(o)(e) no projeto e queira contribuir para algum dos projetos do HoCo por favor dê uma olhada nas issues de cada projeto, se você achou uma issue que lhe interessa leia os documentos de Código de conduta e Contribuindo para saber mais detalhes.

⚠️ Ainda estamos trabalhando no projeto, caso você queira acompanhar o avanço do repositório dê um estrelinha ⭐ para você não perder as atualizações do rep.

📌 Mantenedores

Contribuidores

✏️ Licença e Copyright

MIT © Licença


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