README.md

CAPJu - Front

Sobre Projetos

O CAPJu é abreviação para "Controle e Acompanhamento de Processos da Justiça", no qual trata-se de uma projeto de código aberto que tem como objetivo ajudar os usuários da 4ª vara cível da Justiça Federal na realização de gerenciar os processos.

Este repositório, em especial, é totalmente dedicado à manutenção dos detalhes do Microserviço Front do projeto. Sinta-se livre para contribuir, mas antes leia o guia de contribuição.

O CAPJu é uma aplicação Web compatível com qualquer navegador.

Tecnologias

Instalação

Configurando .env.local

Configure o arquivo .env.local dos repositório igual abaixo:

VITE_API_SERVICE_URL=
VITE_USER_SERVICE_URL=
VITE_UNITS_SERVICE_URL=
VITE_STAGES_SERVICE_URL=
VITE_PROCESSES_SERVICE_URL=
VITE_FLOWS_SERVICE_URL=

Obs: é necessário ser igual ao back-end.

Execute o projeto

Para executar o projeto é recomendar executar os comandos na ordem de repositórios de back-end primeiro e front-end ao final. E cada um em um terminal diferente.

Os comandos de execução do ambiente do projeto estão todos descritos no arquivo Makefile, desde sua instalação, passando pela execução até possíveis remoções, sendo aqui descritas apenas a sua instalação e execução:

# Para rodar o projeto pela primeira vez basta executar o comando:

make first

# Após sua execução a aplicação deve estar na porta 3000, bastando acessar o endereço localhost:3000 no navegador.
# Para as próximas execução basta executar o comando:

make start

# Para interromper a execução da aplicação execute o comando:

make stop

Instalação local

Para executar a aplicação localmente (fora do ambiente dockerizado), basta executar os comandos:

yarn # Instala as bibliotecas 

# E em seguida

yarn dev # Inicia a execução da aplicação na porta 3000

Testes

Para rodar os testes execute:

yarn test

Instalando Novas Dependecias

Pode ser utilizado o seguinte comando para inserir novas dependencias na aplicação:

yarn add nome-da-dependencia

Veja que, o exemplo acima adiciona a biblioteca no ambiente local, para realizar a instalação no container docker execute:

# Esse comando deve abrir um terminal dentro do container, 
# certifique-se que o nome do container (capju-front) coincide com o nome do ambiente em sua máquina
docker-compose exec -it capju-front sh

# Agora sim podemos instalar a biblioteca normalmente
yarn add nome-da-dependencia

# E para sair de dentro do container
exit

Deployment

GitHub Actions.

Contribuição

Certifique-se de ler o Guia de Contribuição antes de realizar qualquer atividade no projeto!

Licença

O CAPJu está sob as regras aplicadas na licença MIT

Contribuidores