welistonbelles / ecommerce-cars

Projeto desenvolvido afim de praticar a manipulação de parâmetros de uma API.

README

Sobre Tecnologias Funcionalidades Demonstração Instalação

Sobre

Este projeto foi construído com o intuito de praticar a manipulação de parâmetros de uma API utilizando Django e Django Rest Framework para construção da API REST seguindo o padrão REST Full.
Consiste em um ecommerce de carros onde é possível aplicar diversos filtros, seja por marca, modelo, categoria, ordenar por preço em ordem crescente ou decrescente, dentre outros.

OBS: Este projeto não tem como intuito possuir uma interface totalmente estilizada/responsiva, mas sim possuir 1 backend bem construído.

Tecnologias

O projeto foi construído utilizando as seguintes tecnologias para o backend:

• Python
• Django
• Django Rest Framework

O front-end foi construído com:

• JavaScript
• HTML5
• CSS

Já para o banco de dados, optei por utilizar:

• MySQL

Para a construção dos testes automatizados a escolha foi utilizar o:

• PyTest

E por fim, a documentação da API foi construída utilizando:

• Swagger

Funcionalidades

✔️ Listar os veiculos.
✔️ Filtrar os veiculos.
✔️ Paginação.
✔️ Testes Automatizados da API.
✔️ Documentação da API.

Demonstracao

Estoque Documentação (Pode ser acessada pelo endpoint /doc)

Instalacao

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Python e um servidor MySQL, recomendo o MySQLWorkbench. Além disso é bom ter um editor para trabalhar com o código como o VSCode ou o PyCharm (Recomendado).

# Clone este repositório
$ git clone <https://github.com/welistonbelles/ecommerce-cars>

# Acesse a pasta do projeto no terminal/cmd
$ cd ecommerce-cars

# Instale as dependências
$ pip install -r requirements.txt

🔧 Configuracao

# Conecte o arquivo ecommerce.sql com o seu banco de dados MySQL.

# Abra o arquivo config/settings.py e nesta parte configure de acordo com seu banco de dados
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'ecommerce',
        'USER': 'root',
        'PASSWORD': '',
        'HOST': 'localhost', # caso rode em localhost
        'PORT': '3306', # porta padrão
    }
}

# Após conectar com seu banco de dados, é hora de rodarmos as migrates.

# Aplique as migrations ao seu banco de dados
python manage.py migrate

# Com tudo configurado, basta rodarmos nossa aplicação:
python manage.py runserver