vcnafacul / client-vcnafacul

GNU General Public License v3.0
2 stars 0 forks source link
hacktoberfest
Logo

Frontend Você na Facul

Principal linguagem do projeto Quantidade de linguagens utilizadas Tamanho do repositório Licença Github issues Github pull requests

Descrição

Somos uma equipe de voluntários trabalhando por um bem maior: a EDUCAÇÃO. Queremos que o ambiente universitário seja justo e igualitário, e que o desejo de ingressar no ensino superior não dependa de cor, gênero, orientação sexual ou classe social.

Ambiente

Desenvolvimento

Para rodar o projeto em ambiente de Desenvolvimento, siga os passos abaixo:

  1. Clone o repositório
  2. Execute o comando yarn para instalar as dependências
  3. Verifique se existe o arquivo .env.development na raiz do projeto
  4. Execute o comando yarn dev para rodar o projeto
  5. Abra o navegador e acesse http://localhost:5173
  6. Para fins de login, clone o repositório de backend em api-vcnafacul
Homologação

Para rodar o projeto em ambiente de Homologação ...

  • Se seu sistema for windows, necessário instalar Docker Desktop
  • Para os demais sistemas ou utilizando o Windows Subsystem for Linux wsl, o docker é necessário, mas caso não possua, será instalado durante o processo de subida da aplicação.

Processo de Up do ambiente de homologação

  1. Verifique se existe o arquivo .env.qa, caso não, crie um a partir de .env.qa.example e preencha as informações pertinentes
  2. Rode o script ./run_qa.sh
    • Em sistemas windows, o arquivo deve ser executado no terminal git bash
  3. O processo de up das aplicações client-vcnafacul, api-vcnafacul e ms-vcnafacul levá um tempo para
    • Instalar o docker, caso não possua
    • Baixar as imagens do projeto do repositorio do Docker Hub
    • Subir a aplicação
  4. Uma vez o processo ser finalizado com done, abra o navegador e acesse http://localhost:5173

Principais tecnologias neste projeto

Principais tecnologias nos demais projetos

Contribuição

Sinta-se à vontade para abrir uma issue ou um pull request caso queira contribuir. Toda ajuda é bem-vinda!

Contato

Se tiver alguma dúvida, entre em contato através do nosso site Você na Facul.