Git Product home page Git Product logo

api_inquest's Introduction

Descrição da API:

  • Registro de pessoas, a partir do CPF

  • Registro de empresas e donos da empresa(podendo ser pessoas físicas e ou jurídicas, ou seja uma empresa que tem como dono uma outra empresa)

  • Registro de bens e posses de um indivíduo

Requisitos da API:

  • Desenvolvimento em Python 3+

  • Boa cobertura de Testes unitários e outros testes que julgar necessários

  • Documentação (pode ser docstrings ou um Markdown)

  • Docker e/ou algum aparato de containerização e deployment

Requisitos mínimos para executar o projeto:

É necessário ter o python e o pip instalados, depois basta rodar o comando:

$ pip install docker-compose

Para rodar a aplicação pela primeira vez rode as migrações do Django:

$ docker-compose up migration

Por último execute o docker-compose para executar o Django efetivamente:

$ docker-compose up web

Para acessar a documentação da API, com a aplicação rodando, abra o navegador em:

Localhost

Se tudo estiver certo, a seguinte página será exibida:

Sucesso!

Á partir daí podemos usar o próprio navegador para testar a API, por exemplo ao abrir o link: Pessoas podemos ver a listagem de pessoas e um formulário para criar novas pessoas. O funcionamento é o mesmo para Empresas e Posses.

Caso queira executar os testes unitários execute o comando:

$ docker-compose up unittests

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.