{"id":19036368,"url":"https://github.com/thenriquedb/polls-api","last_synced_at":"2026-04-12T01:38:27.523Z","repository":{"id":222845773,"uuid":"753658897","full_name":"thenriquedb/polls-api","owner":"thenriquedb","description":"Esta API permite aos usuários criar enquetes e visualizar seus resultados em tempo real.","archived":false,"fork":false,"pushed_at":"2024-02-16T14:41:56.000Z","size":77,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-02T05:41:42.883Z","etag":null,"topics":["docker","fastify","nodejs","redis","solid-principles"],"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/thenriquedb.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}},"created_at":"2024-02-06T14:57:36.000Z","updated_at":"2024-02-16T14:42:39.000Z","dependencies_parsed_at":"2024-02-16T15:47:35.199Z","dependency_job_id":"4ab970bf-7e8a-4e42-9895-c6002858a3c6","html_url":"https://github.com/thenriquedb/polls-api","commit_stats":null,"previous_names":["thenriquedb/polls-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenriquedb%2Fpolls-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenriquedb%2Fpolls-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenriquedb%2Fpolls-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thenriquedb%2Fpolls-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thenriquedb","download_url":"https://codeload.github.com/thenriquedb/polls-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240093147,"owners_count":19746776,"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":["docker","fastify","nodejs","redis","solid-principles"],"created_at":"2024-11-08T21:54:16.050Z","updated_at":"2026-04-12T01:38:27.463Z","avatar_url":"https://github.com/thenriquedb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Polls\n\nA API de Enquetes é uma aplicação simples desenvolvida durante o evento NLW Expert da Rocketseat, e posteriormente refatorada para aplicar os principais conceitos SOLID, visando melhorar a estrutura e organização da base de código. \n\nEsta API permite aos usuários criar enquetes e visualizar seus resultados em tempo real. \n\n## Tecnlogias\n\n- **Node**.js: Ambiente de execução JavaScript do lado do servidor.\n- **Fastify**: Um framework web leve e eficiente para Node.js.\n- **Prisma**: ORM para manipulação de dados, facilitando a interação com o banco de dados.\n- **PostgreSQL**: Banco de dados relacional utilizado para armazenar os dados das enquetes.\n- **Redis**: Sistema de cache utilizado para armazenar e distribuir os resultados em tempo real.\n- **WebSocket**: Protocolo de comunicação bidirecional em tempo real para envio das informações ao cliente.\n\n## Instalação\n\n\u003e Certifique-se de ter o Node.js, Docker e Docker Compose instalados em sua máquina.\n\n1. Clone este repositório:\n```bash\ngit clone https://github.com/thenriquedb/polls-api/\n```\n2. Acesse o diretório do projeto:\n```bash\ncd polls-api\n```\n3. Instale as depedências:\n```bash\nnpm install # or yarn\n```\n4. Execute o Docker Compose:\n```bash\ndocker-compose up\n```\n5. Execute o projeto\n```bash\nnpm run dev # ou yarn dev\n```\nA API estará disponível em **http://localhost:3333**.\n\n## Endpoints\n\n### POST ``/polls``\n**Request body**\n```json\n  {\n    \"title\": string,\n    \"options\": string[],\n  }\n```\n\n**Response**\n```json\n  {\n    \"pollId\": UUID\n  }\n```\n\n### GET ``/polls/:pollId``\n**Response**\n```json\n    {\n        \"poll\": {\n            \"id\": UUID,\n            \"title\": string,\n            \"options\": {\n                \"id\": UUID,\n                \"title\": string,\n                \"score\": number\n            }[]\n        }\n    }\n```\n\n### POST ``/polls/:pollId/votes``\n**Request body**\n```json\n  {\n    \"pollOptionId\": UUID\n  }\n```\n\n### WEBSOCKET ``/polls/:pollId/results``\n```json\n{\n    \"pollOptionId\": string,\n    \"votes\": number\n}\n```\n\n## Estrutura do projeto\n```bash\n.\n└── poll-api/\n    ├── prisma \n    └── src/\n        ├── infra/\n        │   ├── http/\n        │   │   ├── controllers\n        │   │   ├── app.ts # HTTP app configure\n        │   │   └── server.ts # Run server \n        │   └── storage/\n        │       ├── prisma.ts # Prisma config file\n        │       └── redis.ts # Redis singleton\n        ├── repository # manage data access logic\n        │   └── example-repository \n        ├── use-cases # bussines rules\n        │   └── example-use-case/\n        │       ├── example-use-case.ts\n        │       ├── index.ts\n        │       └── make-example-use-case.ts # Factory to build use-case\n        └── util # common utilitaries\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenriquedb%2Fpolls-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthenriquedb%2Fpolls-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenriquedb%2Fpolls-api/lists"}