Skip to content

CAPJu/User

Repository files navigation

CAPJu - User

logo

User-CI Coverage

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 a gerenciar processos jurídicos.

Este repositório, em especial, é totalmente dedicado à manutenção dos detalhes do Microserviço User 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

nodeJSExpressMongoBDMogooseReactJSDocsify

Este é o repositório foi utilizado o seguinte para seu desenvolvimento:

  • Node.js (Latest Version) Como ambiente de execução de JavaScript.
  • Express.js Como framework de servidor e camada de controller.
  • MongoDB Como camada de banco de dados
  • Mongoose Como camada "ODM" / model

Demais Repositórios

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.

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

Abra http://localhost:3000 para ver em seu navegador.

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

Instale as dependências do NodeJs

$ yarn install

Execute o servidor

$ yarn start

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 realização 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

Instale as dependencias.

$ yarn install

Inicie a aplicação

$ yarn start

Testes

Para rodar os testes execulte:

$ yarn test

Instalando de Dependecias

Pode ser utilizado o seguinte comando para inserir novas dependencias no sistema

$ yarn add "nome_da_dependencia"

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