O back-end do sistema de levantamento dos equipamentos do MPF/PI.
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.
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:
- Baixe e instale o Cyrus SASL
- Baixar Cyrus SASL
- Instruções de instalação do Cyrus SASL. Recomendamos usar o método de instalação
Tarball installation.
- Baixe e instale o OpenSSL
- Baixar OpenSSL
- [Instruções de instalação do OpenSSL] (https://github.com/openssl/openssl/blob/master/NOTES.UNIX)
- Baixe e instale o OpenLDAP
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. Recomendamos que você ative seu ambiente virtual.
Clonando o repositório...
$ git clone https://github.com/luiscarlossf/inventory-api.git
$ cd inventory-api
$ git checkout dev
(Recomendável) Criando e ativando ambiente virtual...
$ mkvirtualenv test
Instalando as dependências do projeto...
$ pip3 install -r requirements.txt
Migrando definições dos modelos para o banco de dados...
$ python3 manage.py migrate
Criando super usuário...
$ python3 manape.py createsuperuser --username [SEU USERNAME] --email [SEU EMAIL]
$ Password:
$ Password (again):
Executando o projeto...
$ python3 manage.py runserver
A API vai está rodando no seguinte endereço: http://127.0.0.1:8000/{VERSION_API}
VERSION_API é a versão da API que deseja acessar, por exemplo: http://127.0.0.1:8000/v1 .
Você pode visualizar a documentação da API acessando: http://127.0.0.1:8000/redoc ou http://127.0.0.1:8000/swagger-ui .
Os testes automatizados são executados com a framework de testes do Django.
$ python3 manage.py test
Qualquer observação adicional sobre como fazer o deploy do sistema será adicionada nessa seção.
- Django REST - A framework para WEB API usada.
- Django Authentication Using LDAP - Serviço de autenticação LDAP
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.
Usamos o URL Path para versionamento. Para as versões disponíveis, veja as tags nesse repositório.
- Luis Carlos - Projeto de estágio - luiscarlossf
Veja a lista de contribuidores que participaram desse projeto.
Esse projeto é licenciado sobre a GNU General Public License v3.0- veja o arquivo LICENSE.md para mais detalhes.