{"id":31641928,"url":"https://github.com/gabskydev/property-match","last_synced_at":"2025-10-07T03:26:32.641Z","repository":{"id":311667173,"uuid":"1044456205","full_name":"GabSkyDev/property-match","owner":"GabSkyDev","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-28T18:02:37.000Z","size":9966,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-28T20:24:17.054Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/GabSkyDev.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-25T17:57:58.000Z","updated_at":"2025-09-28T18:02:40.000Z","dependencies_parsed_at":"2025-09-28T20:24:30.710Z","dependency_job_id":null,"html_url":"https://github.com/GabSkyDev/property-match","commit_stats":null,"previous_names":["gabskydev/desafio-tecnico-amora","gabskydev/property-match"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/GabSkyDev/property-match","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabSkyDev%2Fproperty-match","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabSkyDev%2Fproperty-match/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabSkyDev%2Fproperty-match/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabSkyDev%2Fproperty-match/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GabSkyDev","download_url":"https://codeload.github.com/GabSkyDev/property-match/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabSkyDev%2Fproperty-match/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278714671,"owners_count":26033125,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-10-07T03:26:28.868Z","updated_at":"2025-10-07T03:26:32.635Z","avatar_url":"https://github.com/GabSkyDev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Property Match API\n\n## Descrição\nMVP inicial do backend para startup que resolve problemas do mercado imobiliário.  \nO projeto tem como objetivo fornecer uma API para gerenciamento de imóveis, permitindo que usuários e corretores armazenem e acessem seus imóveis via endpoints REST.  \nAlguns endpoints possuem autenticação via JWT (incentivando registro posterior).\n\n## Status do Projeto\nAlguns requisitos finais ainda não foram implementados ou estão parcialmente concluídos.  \nA entrega prioriza apresentar a arquitetura, endpoints principais e um fluxo básico de autenticação.\n\n## Stack Utilizada\n- **Node.js** com **Express**\n- **TypeScript**\n- **JWT** para autenticação\n- **PostgreSQL** para persistência de dados\n\n## Passo a Passo para Rodar o Projeto\n### Pré-requisitos\n- Node.js (\u003e= 18.x)\n- NPM ou Yarn\n- PostgreSQL em execução local ou remoto\n\n### Clonando o repositório\n```bash\ngit clone https://github.com/seu-usuario/desafio-tecnico-amora.git\ncd desafio-tecnico-amora\n```\n\n### Instalando as dependências\n```bash\nnpm install\n```\n\n### Configurando variáveis de ambiente\n\nCrie um arquivo .env na raiz do projeto com os seguintes parâmetros:\n\n```\nJWT_SECRET=sua_chave_secreta\nPORT=3000\n```\n\n### Executando o servidor\n```\nnpm run dev\n```\n\n## Decisões Técnicas e de Produto\n\n- **Uso do Express com TypeScript:**\nEscolhido por sua leveza e flexibilidade para montar rapidamente uma API RESTful.\n\n- **JWT para autenticação:**\nPermite endpoints seguros para criação, listagem e gerenciamento de imóveis de usuários e corretores.\nE incentiva que novos usuários se registrem para acessar novas funcionalidades como atualização ou deleção.\n\n- **PostgreSQL:**\nBanco relacional que oferece robustez e escalabilidade para dados transacionais de imóveis.\n\n- **Estrutura Modular:**\nDivisão em rotas, controllers e services para melhor manutenção.\n\n## Testes\nVocê pode testar os endpoints da API usando ferramentas como Postman, Insomnia ou até curl. Abaixo estão os principais endpoints e exemplos de requisições com JSON.\n\n### 1. Usuários\n- Listar todos os usuários\n```GET /users```\n\n- Buscar usuário por ID\n```GET /users/:id```.  \nHeaders:\n  Authorization: Bearer \u003cseu_token\u003e\n\n- Atualizar usuário\n```PUT /users/:id```.  \nHeaders:\n  Authorization: Bearer \u003cseu_token\u003e.   \n\nBody (JSON):\n```json\n{\n  \"name\": \"Novo Nome\",\n  \"email\": \"novoemail@email.com\",\n  \"password\": \"novaSenha123\"\n}\n```\n\n- Deletar usuário\n```DELETE /users/:id```.\n\nHeaders:\n  Authorization: Bearer \u003cseu_token\u003e\n\n### 2. Listas de Propriedades\n- Criar lista de propriedades\n```POST /users/:userId/property-lists```.\n\nBody (JSON):\n```json\n{\n  \"name\": \"Minha Lista de Imóveis\"\n}\n```\n\n- Listar todas as listas de um usuário\n```GET /users/:userId/property-lists```\n\n- Buscar lista por ID\n```GET /users/:userId/property-lists/:listId```.\n\nHeaders:\n  Authorization: Bearer \u003cseu_token\u003e\n\n- Atualizar lista de propriedades\n```PUT /users/:userId/property-lists/:listId```.  \nHeaders:\n  Authorization: Bearer \u003cseu_token\u003e.\n  \nBody (JSON):\n```json\n{\n  \"name\": \"Nome Atualizado da Lista\"\n}\n```\n\n- Deletar lista de propriedades\n```DELETE /users/:userId/property-lists/:listId```.\n\nHeaders:\n  Authorization: Bearer \u003cseu_token\u003e\n\n### 3. Propriedades\n- Criar propriedade\n```POST /users/:userId/property-lists/:listId/properties```.\n\nBody (JSON):\n```json\n{\n  \"title\": \"Apartamento 2 quartos\",\n  \"price\": 250000,\n  \"adress\": \"Rua Exemplo, 123\",\n  \"url\": \"http://linkdaprop.com\",\n  \"comments\": \"Ótima localização\"\n}\n```\n\n- Listar todas as propriedades de uma lista\n```GET /users/:userId/property-lists/:listId/properties```\n\n- Buscar propriedade por ID\n```GET /users/:userId/property-lists/:listId/properties/:propId```\n\n- Atualizar propriedade\n```PUT /users/:userId/property-lists/:listId/properties/:propId```.\n\nHeaders:\n  Authorization: Bearer \u003cseu_token\u003e.\n  \nBody (JSON):\n```json\n{\n  \"title\": \"Apartamento 3 quartos\",\n  \"price\": 300000,\n  \"adress\": \"Rua Exemplo, 456\",\n  \"url\": \"http://linkdaprop.com\",\n  \"comments\": \"Renovado recentemente\"\n}\n```\n\n- Deletar propriedade\n```DELETE /users/:userId/property-lists/:listId/properties/:propId```.\n\nHeaders:\n  Authorization: Bearer \u003cseu_token\u003e\n\n### Autenticação Opcional\nA API possui endpoints para registro e login, que permitem criar usuários e gerar o JWT necessário para acessar endpoints protegidos, incentivando o cadastro para persistência dos dados.\n\n### 1. Registrar usuário\n```POST /register```.  \n\nBody (JSON):\n```json\n{\n  \"name\": \"Seu Nome\",\n  \"email\": \"seuemail@email.com\",\n  \"password\": \"senha123\"\n}\n```\n\nResposta esperada:\n```json\n{\n  \"id\": \"uuid-do-usuario\",\n  \"name\": \"Seu Nome\",\n  \"email\": \"seuemail@email.com\",\n  \"role\": \"lead\"\n}\n```\n\n### 2. Login\n```POST /login```.  \n\nBody (JSON):\n```json\n{\n  \"email\": \"seuemail@email.com\",\n  \"password\": \"senha123\"\n}\n```\n\nResposta esperada:\n```json\n{\n  \"token\": \"\u003cJWT_GERADO\u003e\"\n}\n```\n\n💡 Use o token retornado no cabeçalho Authorization: Bearer \u003ctoken\u003e para acessar endpoints protegidos como /users/:id, /property-lists/:listId, etc.\n\n## Limitações e Implementações futuras\n- Implementar sistema de comparação de imóveis.\n- Adicionar notificações automáticas e sugestões.\n- Criar endpoints colaborativos (listas compartilhadas).\n- Integrar com WhatsApp para captação de leads.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgabskydev%2Fproperty-match","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgabskydev%2Fproperty-match","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgabskydev%2Fproperty-match/lists"}