https://github.com/moreirak14/logistics-transport-api

O objetivo do sistema é auxiliar o cadastramento de motoristas (caminhoneiros) e seus devidos fretes futuros, tendo visibilidade do que está sendo atribuido para cada motorista!
https://github.com/moreirak14/logistics-transport-api

api-rest django django-rest-framework poetry python sqlite3 unit-testing

Last synced: over 1 year ago
JSON representation

O objetivo do sistema é auxiliar o cadastramento de motoristas (caminhoneiros) e seus devidos fretes futuros, tendo visibilidade do que está sendo atribuido para cada motorista!

• Host: GitHub
• URL: https://github.com/moreirak14/logistics-transport-api
• Owner: moreirak14
• Created: 2022-09-03T02:30:11.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-09T02:48:37.000Z (almost 4 years ago)
• Last Synced: 2024-10-24T02:30:09.899Z (over 1 year ago)
• Topics: api-rest, django, django-rest-framework, poetry, python, sqlite3, unit-testing
• Language: Python
• Homepage:
• Size: 68.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Logistics Transport API

O objetivo do sistema é auxiliar o cadastramento de motoristas

(caminhoneiros) e seus devidos fretes futuros, tendo visibilidade do que está

sendo atribuido para cada motorista!

## Pré-requisitos

- Python 3.10+: `https://www.python.org/downloads/`

- Docker: `https://www.docker.com/`

- Poetry: `https://python-poetry.org/docs/#installation`

## Necessário

- Criar novo arquivo `.secrets.toml`: Será necessário copiar o arquivo `.

  example.secrets.toml` para `.secrets.toml`.

  - O `secret.toml` é onde localiza variaveis sensiveis da aplicação.

- Para criar automaticamente o arquivo mencionado:

`$ make copy-envs`

## Utilização em desenvolvimento local

O arquivo `Makefile` que existe na raiz do projeto, tem todos os comandos necessários mapeados.

- Para instalar todos os pacotes necessários e criar um ambiente virtual:

`$ poetry shell` ou `$ poetry install` ou `$ make setup`

- Para subir as migrações de database:

`$ python manage.py migrate` ou `$ make migrate`

- Para gerar uma nova migração de database:

`$ python manage.py makemigrations` ou `$ make makemigrations`

- Para executar a aplicação:

`$ python manage.py runserver` ou `$ make run`

## Documentação

O sistema contém documentação de API, será possivel analisar toda a

estrutura após inicializar o sistema e acessar à url:

`http://localhost:8000/swagger/` ou

`http://localhost:8000/redoc/`