README - luiscarlossf/inventory-api GitHub Wiki

Inventory API

O back-end do sistema de levantamento dos equipamentos do MPF/PI.

Getting Started

Essas instruções fornecerão uma cópia do projeto e execução na sua máquina local para fins de desenvolvimento e teste. Consulte deployment para obter notas sobre como colocar o projeto em produção.

Pré-requisitos

Usamos o pacote Django Auth LDAP para fazer a autenticação LDAP, você precisará das bibliotecas e cabeçalhos do OpenLDAP disponíveis no seu sistema. Para isso, siga as instruções a seguir:

  1. Baixe e instale o Cyrus SASL
  1. Baixe e instale o OpenSSL
  1. Baixe e instale o OpenLDAP

Instalação

Um passo a passo mostrando como obter o ambiente de desenvolvimento em execução. Lembrando que é necessário que você esteja no diretório raiz do projeto antes de executar os comandos a seguir.

Instalando as dependências do projeto...

$ pip3 install -r requirements.txt

Executando o projeto...

$ python3 manage.py runserver

Execução de testes

Os testes automatizados são executados com a framework de testes do Django.

$ python3 manage.py test

Deployment

Qualquer observação adicional sobre como fazer o deploy do sistema será adicionada nessa seção.

Construída com

Contribuição

Por favor, leia CONTRIBUTING.md para detalhes do nosso código de conduta, e o processo para submissão de pull requests para nós.

Versionamento

Usamos o URL Path para versionamento. Para as versões disponíveis, veja as tags nesse repositório.

Autores

Veja a lista de contribuidores que participaram desse projeto.

Licença

Esse projeto é licenciado sobre a GNU General Public License v3.0- veja o arquivo LICENSE.md para mais detalhes.

Agradecimentos