{"id":25376457,"url":"https://github.com/ArthurSilvaDantas/ClarkeEnergia-API","last_synced_at":"2025-10-30T07:31:20.707Z","repository":{"id":277242607,"uuid":"931777955","full_name":"Arthur-SD15/ClarkeEnergia-API","owner":"Arthur-SD15","description":"Desafio Técnico - Clarke Energia | Processo seletivo para vaga de Desenvolvedor(a) Junior.","archived":false,"fork":false,"pushed_at":"2025-02-12T21:58:48.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T22:34:07.666Z","etag":null,"topics":["api","api-rest","nestjs","nestjs-backend","prisma","prisma-orm","rest","rest-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Arthur-SD15.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-12T20:54:34.000Z","updated_at":"2025-02-12T21:58:51.000Z","dependencies_parsed_at":"2025-02-12T22:44:14.717Z","dependency_job_id":null,"html_url":"https://github.com/Arthur-SD15/ClarkeEnergia-API","commit_stats":null,"previous_names":["arthur-sd15/clarkeenergia-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arthur-SD15%2FClarkeEnergia-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arthur-SD15%2FClarkeEnergia-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arthur-SD15%2FClarkeEnergia-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Arthur-SD15%2FClarkeEnergia-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Arthur-SD15","download_url":"https://codeload.github.com/Arthur-SD15/ClarkeEnergia-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238945663,"owners_count":19556699,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-rest","nestjs","nestjs-backend","prisma","prisma-orm","rest","rest-api","typescript"],"created_at":"2025-02-15T04:27:53.604Z","updated_at":"2025-10-30T07:31:20.694Z","avatar_url":"https://github.com/Arthur-SD15.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Banner](/public/images/readme/background-readme.png)\n\n## :warning: Aviso\n\nA aplicação pode sofrer um **cold start** na **primeira requisição** devido à inatividade. Pode levar até 50 segundos para responder à primeira requisição, pois o back-end está hospedado no plano gratuito do Render.\n\n\n## :bulb: Repositório\n\nNeste repositório, documentarei os aspectos importantes do back-end para o desafio técnico da vaga de Desenvolvedor Júnior na Clarke Energia. Para acessar a documentação do front-end, acesse o repositório clicando [aqui](https://github.com/Arthur-SD15/ClarkeEnergia).\n\n\n## :computer: Projeto\n\nO principal objetivo deste projeto é permitir que os usuários informem seu consumo de energia sendo um número maior que 0, e com base nesse dado, encontrem os melhores fornecedores que mais se adequam às suas necessidades. O projeto conta com duas tabelas no banco de dados: uma para **usuários** e outra para **fornecedores**. Essas tabelas possuem os seguintes atributos:\n\n```prisma\nmodel suppliers {\n  id            String  @id @default(uuid())\n  name          String\n  logo          String\n  state         String\n  costPerKwh    Float\n  minKwhLimit   Float\n  totalClients  Int\n  averageRating Float\n\n  createdAt     DateTime @default(now())\n  updatedAt     DateTime @updatedAt\n}\n\nmodel users {\n  id        String    @id @default(uuid())\n  name      String?\n  surname   String?\n  birthDate DateTime?\n  email     String    @unique\n  password  String?\n  googleId  String?   @unique\n\n  createdAt DateTime @default(now())\n}\n```\nNo próximo tópico da documentação, irei detalhar as rotas e os métodos HTTP disponíveis para interação com a API, bem como suas respectivas regras de negócio.\n\n\n## :left_right_arrow: Rotas/Regras de Negócios\n\n- *Endpoint:* `/`\n    - **Método**: `GET`\n        - **Descrição**: Retorna uma mensagem de boas vindas, indicando que a API está funcionando corretamente.\n- *Endpoint:* `/auth/login`\n    - **Método**: `POST`\n        - **Descrição**: Na autenticação manual, realiza a autenticação de um usuário com base no e-mail e senha fornecidos na requisição.\n- *Endpoint:* `/auth/google`\n    - **Método**: `GET`\n        - **Descrição**: Inicia o processo de autenticação utilizando a estratégia de autenticação do Google. O usuário será redirecionado para o Google para realizar o login.\n- *Endpoint:* `/auth/google/callback`\n    - **Método**: `GET`\n        - **Descrição**: Recebe a resposta do Google após o login e gera um token JWT para o usuário. O token gerado é então enviado como parte da URL de redirecionamento para a aplicação cliente.\n- *Endpoint:* `/users`\n    - **Método**: `POST`\n        - **Descrição**: Cria um novo usuário, a requisição exige que sejam enviados os dados necessários para criação do usuário, onde não pode existir um usuário já cadastrado pelo email, a data de nascimento deve ser menor que tal dia e a senha deve possuir mais de 5 caracteres.\n- *Endpoint:* `/users`\n    - **Método**: `GET`\n        - **Descrição**: Retorna uma lista de todos os usuários registrados no sistema.\n- *Endpoint:* `/users/:email`\n    - **Método**: `GET`\n        - **Descrição**: Retorna os dados de um usuário específico, identificado pelo e-mail fornecido na URL.\n- *Endpoint:* `/users/:id`\n    - **Método**: `GET`\n        - **Descrição**: Retorna os dados de um usuário específico, identificado pelo e-mail fornecido na URL.\n- *Endpoint:* `/users/:id`\n    - **Método**: `DELETE`\n        - **Descrição**: Remove um usuário do sistema com base no ID fornecido na URL.\n- *Endpoint:* `/suppliers`\n    - **Método**: `POST`\n        - **Descrição**: A requisição para criar um novo fornecedor exige que sejam enviados os dados necessários para a criação, com as seguintes validações: o nome do fornecedor não pode ser duplicado; o estado deve ser uma sigla válida de um estado brasileiro; a média de avaliação deve estar entre 1 e 5; o custo por KWh não pode ser inferior a 1; o limite mínimo de KWh não pode ser menor que 1; e o total de clientes não pode ser negativo. Caso algum desses critérios não seja atendido, será retornado um erro com a mensagem correspondente. Se todas as regras forem seguidas corretamente, o fornecedor será criado com sucesso.\n- *Endpoint:* `/suppliers`\n    - **Método**: `GET`\n        - **Descrição**: Retorna os dados dos fornecedores, filtrados com base no consumo informado. Filtra de acordo com o limite mínimo de energia de cada fornecedor.\n        - **Query**: `/suppliers?name=Fornecedor%20X\u0026state=SP\u0026averageRating=4.5\u0026costPerKwh=0.45\u0026minKwhLimit=300\u0026totalClients=1500` para filtrar os dados, os respectivos valores devem ser informados com o tipo correto.\n- *Endpoint:* `/suppliers/by-consumption`\n    - **Método**: `GET`\n        - **Descrição**: Retorna os dados dos fornecedores, filtrados com base no consumo informado, onde filtra de acordo com o limite minimo de energia de cada fornecedor. A requisição exige que seja passado o parâmetro de consumption na query string. O valor de consumption deve ser maior que 0.\n        - **Query**: `consumption` número de consumo de energia médio, informado pelo usuário.\n- *Endpoint:* `/suppliers/:id`\n    - **Método**: `GET`\n        - **Descrição**: Retorna os dados de um fornecedor específico, identificado pelo id fornecido na URL.\n- *Endpoint:* `/suppliers/:id`\n    - **Método**: `DELETE`\n        - **Descrição**: Remove um fornecedor do sistema com base no ID fornecido na URL.\n- *Endpoint:* `/suppliers/:id`\n    - **Método**: `PUT`\n        - **Descrição**: Atualiza os dados de um fornecedor existente com base no ID fornecido na URL. A requisição exige que sejam enviados os dados necessários para a atualização, sendo eles: nome, logo, estado, custo por KWh, limite mínimo de KWh, total de clientes e média de avaliação. Onde as regras de negócios são as mesma que para o cadastro.\n        \n\n## :hammer_and_wrench: Tecnologias\n\nPara a criação desta API REST, foram utilizadas as seguintes tecnologias:\n\n- **TypeScript**: Linguagem para o desenvolvimento do back-end.\n- **NestJS**: Framework para construção de aplicações Node.js baseado em TypeScript.\n- **PostgreSQL**: Banco de dados relacional.\n- **Prisma**: ORM que facilita a interação com o banco de dados PostgreSQL.\n- **bcrypt**: Biblioteca de criptografia para hashing de senhas armazenando no banco de dados de maneira criptografada.\n- **JWT (JSON Web Tokens) do NestJS**: Tecnologia utilizada para autenticação e autorização, permitindo a criação de tokens.\n- **passport-google-oauth20**: Autenticação que integra o Google OAuth 2.0, permitindo login com contas do Google.\n\n\n## :arrow_forward: Executar\n```bash\n# Clone o repositório.\n$ git clone https://github.com/Arthur-SD15/ClarkeEnergia-API.git\n\n# Instala todas as dependências.\n$ npm install\n\n# Executa.\n$ npm start\n ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FArthurSilvaDantas%2FClarkeEnergia-API","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FArthurSilvaDantas%2FClarkeEnergia-API","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FArthurSilvaDantas%2FClarkeEnergia-API/lists"}