CRM Skynet Provider - SQLite & FastAPI

Descrição

Este projeto implementa um sistema de gerenciamento de clientes (CRM) para a Skynet Provider, uma empresa fictícia de telecomunicações. O sistema utiliza um banco de dados SQLite e uma API RESTful construída com FastAPI, oferecendo uma solução eficiente e escalável para gerenciar:

• Clientes: Informações de cadastro, contatos e histórico de interações.
• Planos: Detalhes dos planos de serviço, preços e velocidades.
• Contratos: Ativação, upgrade e histórico de contratos de clientes.
• Chamados de Suporte: Abertura, acompanhamento, resolução e histórico de chamados.
• Faturas e Pagamentos: Emissão, acompanhamento de pagamentos e histórico financeiro.

Teste a API OnLine: CRM-FASTAPI

Estrutura do Projeto

CRM-Skynet-Provider-SQLite/FastAPI
├── notebooks
│   └── skynet.ipyng
├── img
│   └── skynet_api.png
│   └── skynetprovider.png
├── db
│   └── skynet.db
├── sql
│   └── create_database.sql
│   └── create_views.sql
│   └── queries.sql
├── src
│   └── main.py
│   └── utils
│       └── criar_bd.py
│       └── gerar_dados.py
│       └── load_data.py
│       └── view_client_info.py
│       └── remove_zone_identifier.sh
└── data
    ├── clientes.csv
    ├── planos.csv
    ├── contratos.csv
    ├── chamados.csv
    ├── atendentes.csv
    ├── historico_atendimento.csv
    ├── faturas.csv
    └── pagamentos.csv

Descrição das Pastas:

• notebooks: Contém notebooks Jupyter para exploração de dados e testes.
• img: Armazena imagens utilizadas no projeto, como logotipos e diagramas.
• bd: Contém o banco de dados SQLite skynet.db.
• sql: Armazena scripts SQL para criação e gerenciamento do banco de dados.
• src: Contém o código-fonte da API FastAPI, incluindo o arquivo principal main.py.
  • utils: Contém todos os scripts necessários para criar o banco de dados.
• data: Contém arquivos CSV com dados de exemplo para popular o banco de dados.

Recursos da API

A API RESTful oferece endpoints para realizar operações CRUD em todos os módulos do CRM, incluindo:

• Criação, leitura, atualização e exclusão de clientes.
• Consulta de planos, contratos, chamados de suporte, faturas e pagamentos.
• Geração de boletos e registro de pagamentos.
• Upgrade de planos e criação de novos contratos.
• Monitoramento de métricas e relatórios para os setores financeiro, comercial e de suporte.

Instalação e Execução

Modo Tradicional (sem Docker)

1. Clone o repositório:

   git clone https://github.com/Jcnok/CRM-Skynet-Provider-SQLite_FastAPI.git

2. Navegue até o diretório do projeto:

   cd CRM-Skynet-Provider-SQLite_FastAPI

3. Instale as dependências com Poetry:

   poetry install

4. Execute a API com Poetry:

   poetry run uvicorn src.app:app --reload

5. Acesse a API:

   A API estará disponível em http://localhost:8000 e a documentação interativa em http://localhost:8000/docs.

Implantação com Docker

O projeto também pode ser facilmente implantado usando Docker.

Pré-requisitos:

• Docker instalado e em execução.
• Docker Compose instalado.

Passos para Implantação:

1. Clone o repositório:

   git clone https://github.com/Jcnok/CRM-Skynet-Provider-SQLite_FastAPI.git

2. Navegue até o diretório do projeto:

   cd CRM-Skynet-Provider-SQLite_FastAPI

3. Execute o Docker Compose:

   docker-compose up -d

4. Acesse a API:

   A API estará disponível em http://localhost:8000 e a documentação interativa em http://localhost:8000/docs.

Tecnologias Utilizadas

• Python: Linguagem de programação principal.
• FastAPI: Framework web para construção da API RESTful.
• SQLite: Banco de dados relacional leve e embutido.
• Pydantic: Biblioteca para validação de dados e modelagem de objetos.
• Poetry: Gerenciador de dependências e ambiente virtual.
• Docker: Plataforma para conteinerização de aplicações.
• Docker Compose: Orquestração da imagem.

Contribuições

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues ou pull requests.

Caso tenha interesse em saber todo o passo à passo do desenvolvimento você pode acessar aqui: PoC_skynet

Licença

Este projeto é licenciado sob a licença MIT.