Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/Refactor(Rodar-Projeto/Item): Automatização de Execução, Inclusão do campo Location com id único adicionado ao barcode e Atualização do README #134

Conversation

Potatoyz908
Copy link
Collaborator

@Potatoyz908 Potatoyz908 commented Jan 10, 2025

Descrição do Pull Request

Este Pull Request implementa melhorias no projeto, incluindo a automatização da execução com make run, atualizações no README e a inclusão do campo location como um identificador único para melhorar o match entre itens perdidos e achados.


O que foi feito?

1. Adicionado Makefile

  • Criado o comando make run, que automatiza o processo de:
    • Navegar para o diretório da API.
    • Rodar docker compose up --build.

2. Atualização do README

  • Substituído o comando anterior (cd API && sudo docker compose up --build) por make run.
  • Corrigida a URL do frontend no README para refletir o endereço correto.

3. Inclusão de location como ID

  • O campo location agora é tratado como uma chave estrangeira para o modelo Location.
  • IDs de localização foram incorporados ao barcode dos itens, seguindo a estrutura:
    Barcode: <Categoria><local><Cor><Marca><Valioso>
    
  • Criado o modelo Location com os campos:
    • name: Nome do local (ex.: "Restaurante Universitário").
    • location_id: Identificador único (ex.: 02).
  • Atualizado o modelo Item para usar location como um campo relacionado.
  • Atualizado o ItemSerializer e as views relacionadas para manipular o campo location.

4. Teste de Criação de Item

  • Foi possível criar um item com as seguintes características:
    {
        "id": 1,
        "barcode": "010101031",
        "name": "Relógio de Ouro",
        "description": "Relógio encontrado no RU",
        "category": 1,
        "location": 2,
        "color": 1,
        "brand": 1,
        "is_valuable": true,
        "status": "found",
        "found_lost_date": null,
        "created_at": "2025-01-10T07:22:22.111599Z",
        "image_urls": [
            "https://res.cloudinary.com/dbujgidbd/image/upload/v1736493743/uoscu6a5fuqczphhnrbp.ico",
            "https://res.cloudinary.com/dbujgidbd/image/upload/v1736493744/lfaus34p5o9jpc6ykhaj.png",
            "https://res.cloudinary.com/dbujgidbd/image/upload/v1736493745/xgxtmywpo8gsln9s1err.jpg"
        ]
    }

Checklist

  • Meu código segue as diretrizes do projeto.
  • Adicionei testes para cobrir as mudanças.
  • Atualizei a documentação, se necessário.

Como Testar?

Automatização com Make

  1. Certifique-se de ter o Make instalado no ambiente:

    make --version
  2. Execute o comando:

    make run

Criação de Item

  1. Envie uma requisição POST para criar um item com localização, por exemplo:
    • Endpoint: POST /api/items/
    • Body:
      {
          "name": "Relógio de Ouro",
          "description": "Relógio encontrado no RU",
          "category": 1,
          "location": 2,
          "color": 1,
          "brand": 1,
          "is_valuable": true,
          "status": "found",
          "images": [
              "file1.jpg",
              "file2.jpg",
              "file3.jpg"
          ]
      }
  2. Verifique se o barcode inclui corretamente o location e os outros atributos.

@Potatoyz908 Potatoyz908 added the devops Related to DevOps development label Jan 10, 2025
@Potatoyz908 Potatoyz908 added this to the Sprint 9 milestone Jan 10, 2025
@Potatoyz908 Potatoyz908 self-assigned this Jan 10, 2025
@Potatoyz908 Potatoyz908 linked an issue Jan 10, 2025 that may be closed by this pull request
8 tasks
@Potatoyz908 Potatoyz908 added the back-end Related to back-end development label Jan 10, 2025
@Potatoyz908 Potatoyz908 linked an issue Jan 10, 2025 that may be closed by this pull request
7 tasks
@Potatoyz908 Potatoyz908 changed the title Feat(Rodar-Projeto): Automatização de Execução e Atualização do README Feat(Rodar-Projeto): Automatização de Execução, Inclusão do campo Location com id único adicionado no barcode e Atualização do README Jan 10, 2025
@Potatoyz908 Potatoyz908 changed the title Feat(Rodar-Projeto): Automatização de Execução, Inclusão do campo Location com id único adicionado no barcode e Atualização do README Feat(Rodar-Projeto): Automatização de Execução, Inclusão do campo Location com id único adicionado ao barcode e Atualização do README Jan 10, 2025
@Potatoyz908 Potatoyz908 changed the title Feat(Rodar-Projeto): Automatização de Execução, Inclusão do campo Location com id único adicionado ao barcode e Atualização do README Feat/Refactor(Rodar-Projeto/Item/MKdocs): Automatização de Execução, Inclusão do campo Location com id único adicionado ao barcode e Atualização do README Jan 10, 2025
@Potatoyz908 Potatoyz908 changed the title Feat/Refactor(Rodar-Projeto/Item/MKdocs): Automatização de Execução, Inclusão do campo Location com id único adicionado ao barcode e Atualização do README Feat/Refactor(Rodar-Projeto/Item): Automatização de Execução, Inclusão do campo Location com id único adicionado ao barcode e Atualização do README Jan 10, 2025
Copy link
Collaborator

@pedroeverton217 pedroeverton217 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ótimo Trabalho!! Boa Euller!

Copy link
Collaborator

@314dro 314dro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Muito boa, Euller!

Copy link
Collaborator

@leoramiroo leoramiroo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ótimo trabalho, Euller!!!

@Potatoyz908 Potatoyz908 merged commit 45d2c0a into main Jan 10, 2025
1 check passed
@Potatoyz908 Potatoyz908 deleted the 133/refactor/alterar-location-para-ser-tratado-como-id-e-incluído-no-barcode branch January 10, 2025 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
back-end Related to back-end development devops Related to DevOps development
Projects
None yet
4 participants