diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..8c23308 --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +PORT=8000 +ENVIRONMENT=development +CHEAPSHARK_API_URL=https://www.cheapshark.com/api/1.0 \ No newline at end of file diff --git a/README.md b/README.md index e69de29..0a7b5ea 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,33 @@ +# 📊 Microsserviço de Analytics e Ranking de Plataformas + +## Integrantes do Grupo +* Ingrid Amim +* Marcelo Ferreira + + +## Descrição do Serviço +Este microsserviço atua como um agregador de inteligência de mercado dentro do ecossistema **GameVerse**. Ele é responsável por coletar, padronizar e processar dados de popularidade e avaliação (Metascore) de jogos em múltiplas plataformas (Steam, Epic Games, PlayStation e Xbox). O serviço quebra os silos de informação, permitindo comparações em tempo real entre mercados fechados (consoles) e abertos (PC). + +## Responsabilidades do Microsserviço +* Consultar APIs externas em tempo real (CheapShark) para obter dados do mercado de PC. +* Realizar a leitura de bancos de dados locais/cache para rankings de consoles. +* Padronizar contratos de dados (Data Normalization) para entregar JSONs unificados ao Front-end. +* Executar Fusão de Dados (Data Fusion) para ranquear os líderes globais de múltiplas plataformas lado a lado. + +## Tecnologias Utilizadas +* **Linguagem:** Python 3.10+ +* **Framework Web:** FastAPI (Alta performance e geração automática de documentação) +* **Servidor ASGI:** Uvicorn +* **Comunicação de Rede:** Biblioteca `requests` + +## Requisitos Necessários +* Python 3.10 ou superior instalado na máquina. +* Gerenciador de pacotes `pip`. +* Git para clonagem do repositório. + +## Passo a Passo de Instalação + +1. Clone o repositório para sua máquina local: +```bash +git clone [https://git.juancjc.com.br/marcelo.brasil/Ranking-por-plataforma.git](https://git.juancjc.com.br/marcelo.brasil/Ranking-por-plataforma.git) +cd Ranking-por-plataforma \ No newline at end of file