CAPJu - Documentação

Sobre Projetos

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

Este repositório é destinado exclusivamente à Documentação do projeto, que está em sua maioria em Português do Brasil, devido aos interessados do público alvo.

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

Tecnologias

Demais Repositórios

• User
• Service
• Interface

Instalação

A aplicação encontra-se em homologação acessando o seguinte LINK

Executando as coisas localmente

Quer ver o projeto funcionando em sua máquina?

Você precisará ter o NodeJS e o Yarn previamente instalados.

E o projeto foi implementado em máquinas com sistemas operacionais de distribuição Linux, portanto os passos encontrados a seguir mostram orientações de sistemas Linux.

Em caso tentativa de execução em outro sistema operacional como, o Windows, recomenda-se uma pesquisa breve. E os usuários do MacOS certamente podem pagar alguém para descobrir como fazer isso.

Executando os Serviços

Nos repositórios 2022-1-CAPJu-Service e 2022-1-CAPJu-User:

$ cd ~/your/directory/
$ git clone https://github.com/fga-eps-mds/2022-1-CAPJu-Service.git
$ cd 2022-1-CAPJu-Service

$ cd ~/your/directory/
$ git clone https://github.com/fga-eps-mds/2022-1-CAPJu-User.git
$ cd 2022-1-CAPJu-User

Caso exista um serviço MongoDB em nuvem, adicione a string de conexão a um arquivo .env dentro na pasta raiz do projeto com nome MONGODB_URI

Caso não seja configurada uma string de conexão personalizada, a aplicação se conectará à porta 27017 do serviço local

No arquvo .env também será necessário que adicione um string com nome JWT_SECRET para realizar a autenticação do usuário

No repositórios 2022-1-CAPJu-Interface:

$ cd ~/your/directory/
$ git clone https://github.com/fga-eps-mds/2022-1-CAPJu-Interface.git
$ cd 2022-1-CAPJu-Interface

Será necessário que adicione uma variavel em um arquivo .env dentro na pasta raiz do projeto com nome REACT_APP_DEV=true para que possa executar na porta 3000 do serviço local

Rodando a documentação localmente

Documentação construida com o gerador de site estático Docsify.

Para executar a documentação na sua máquina, primeiro você precisa instalar

$ yarn global add docsify-cli

ou

$ npm i docsify-cli -g

Depois basta executar

$ docsify serve docs

Deployment

A implantação da documentação está definida a utilização do 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

Disciplina	Matrícula	Nome	Github
MDS	202023903	Lucas Lopes	luclopesr
MDS	170154319	Philipe de Sousa	PhilipeSousa
MDS	202016480	Hellen Fernanda	Hellen159
MDS	170142434	Gabriel Araújo	GabrielGaba
MDS	180126130	Luciano Alves	githubviramundo
MDS	200042416	Pablo Christianno	PabloChristianno
MDS	190091606	Lucas Caldas	lucascaldasb
EPS	160006210	Francisco Heronildo	FranciscoHeronildo
EPS	140156909	Nathalia Lorena	Natilorens
EPS	160010331	José Aquiles	aquiles23
EPS	180013637	Arthur Paiva	arthurpaivat
EPS	180023411	Maicon Lucas	MaiconMares