Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matheusbanqueiro/desafio-smbot

ClientConnect foi um projeto desenvolvido como parte do Desafio Técnico para a vaga de Desenvolvedor Backend no Grupo SM.
https://github.com/matheusbanqueiro/desafio-smbot

celery django docker-compose figma git-actions makefile mvc postgresql postman redis-cache tailwind ubuntu

Last synced: 7 days ago
JSON representation

ClientConnect foi um projeto desenvolvido como parte do Desafio Técnico para a vaga de Desenvolvedor Backend no Grupo SM.

Awesome Lists containing this project

README

        

logo ClientConnect

logo SMBOT

# ClientConnect

Este projeto foi desenvolvido como parte do Desafio Técnico para a vaga de Desenvolvedor Backend no Grupo SM.

[![Descrição do Desafio](https://img.shields.io/badge/Descrição_do_Desafio-Informational?style=for-the-badge&logo=google-docs&logoColor=white&color=3955FF)](https://docs.google.com/document/d/1vb9WExZmk7XXVcp_gMAZ3EK4p8JePjgHS335UGe4vAc/edit?usp=sharing)
[![Documentação API](https://img.shields.io/badge/Documentação_API-Informational?style=for-the-badge&logo=postman&logoColor=white&color=D400CF)](https://documenter.getpostman.com/view/29600204/2sAXqng58h)
[![Figma](https://img.shields.io/badge/Figma-Informational?style=for-the-badge&logo=figma&logoColor=white&color=9400D4)](https://www.figma.com/board/4j8PhXe6WIa10wKMLwXPOt/Desafio-SMBOT---Matheus-Banqueiro-Lima?node-id=0-1&t=OXnSNABngLUJKwap-1)

## Tecnologias Principais

Django
Redis
Celery
RabbitMQ
Postgres
Docker
Tailwind

## Ferramentas de Desenvolvimento

Ubuntu
Postman
Github
Github Actions
MakeFile
VsCode

---

## Como Rodar o Projeto

1. Crie um arquivo `.env` e preencha os dados que estão no arquivo `.env.example`.

2. Entre no seu ambiente virtual (venv). Exemplo para Ubuntu:

```bash
. venv/bin/activate
```

3. Suba o Docker:

```bash
make up
```

4. Execute as migrations:

```bash
make migrations
```

5. Rode em um terminal o app:

```bash
make run
```

6. Rode em outro terminal o celery:

```bash
make celery
```

Se tudo correu bem, você verá a tela inicial:

API-Home

7. Ficou com dúvida sobre algum comando? Execute:

```bash
make help
```

---
## Driagrama de fluxo - Rotas

Estes diagramas oferecem uma visão clara e detalhada do fluxo de dados e das interações dentro da API, facilitando a análise, o acompanhamento e a gestão eficiente do sistema. A ferramenta utilizada para a criação desses diagramas foi o [Mermaid](https://mermaid.js.org/)
.

[![Ver Diagrama de fluxo](https://img.shields.io/badge/Ver_Diagrama_de_fluxo-Informational?style=for-the-badge&logo=mermaid&logoColor=white&color=D400CF)](/diagrams.md)

---
## WebHook Discord

Implementei um WebHook no Discord para receber notificações em tempo real sobre eventos do repositório, como commits, pull requests e o status da pipeline. Assim, posso acompanhar facilmente o progresso do projeto diretamente pelo Discord, centralizando a comunicação.

WebHook Discord

---

## Recursos Adicionais

Para entender melhor, criei alguns documentos no Notion que ajudam tanto iniciantes quanto pessoas que já estão usando Django e precisam tirar dúvidas sobre códigos.

[![Desenrolando Django](https://img.shields.io/badge/Desenrolando_Django-Informational?style=for-the-badge&logo=django&logoColor=white&color=%23006400)](https://cold-mailman-aa4.notion.site/Desenrolando-Django-8681c5f817a3476cbde317a5cac98739?pvs=74)
[![Desenrolando Redis](https://img.shields.io/badge/Desenrolando_Redis-Informational?style=for-the-badge&logo=django&logoColor=white&color=red)](https://cold-mailman-aa4.notion.site/Desenrolando-Redis-Django-10032fcdef508052a6bcdc874349fc57?pvs=74)
[![Desenrolando Celery com RabbitMQ](https://img.shields.io/badge/Desenrolando_Celery_com_RabbitMQ-Informational?style=for-the-badge&logo=celery&logoColor=white&color=orange)](https://cold-mailman-aa4.notion.site/Desenrolando-Celery-RabbitMQ-Django-20104b833b7848c28ba7d82d39b56e2b?pvs=4)