{"id":16785440,"url":"https://github.com/heyloh/happy","last_synced_at":"2025-04-10T23:03:20.018Z","repository":{"id":123013509,"uuid":"303411815","full_name":"heyloh/happy","owner":"heyloh","description":"Leve felicidade para o mundo, visite orfanatos e mude o dia de muitas crianças. NLW#3","archived":false,"fork":false,"pushed_at":"2020-11-03T19:15:00.000Z","size":8041,"stargazers_count":16,"open_issues_count":0,"forks_count":4,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-10T23:03:09.692Z","etag":null,"topics":["expo","happy","nlw-3","nodejs","react-native","reactjs","typeorm","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/heyloh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2020-10-12T14:08:14.000Z","updated_at":"2024-01-30T19:29:42.000Z","dependencies_parsed_at":"2024-08-12T13:20:02.653Z","dependency_job_id":null,"html_url":"https://github.com/heyloh/happy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heyloh%2Fhappy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heyloh%2Fhappy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heyloh%2Fhappy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heyloh%2Fhappy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heyloh","download_url":"https://codeload.github.com/heyloh/happy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248312143,"owners_count":21082638,"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":["expo","happy","nlw-3","nodejs","react-native","reactjs","typeorm","typescript"],"created_at":"2024-10-13T08:09:19.844Z","updated_at":"2025-04-10T23:03:20.010Z","avatar_url":"https://github.com/heyloh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\" \u003e\n  \u003cimg alt=\"happy\" title=\"happy\" src=\"./assets/banner.png\" /\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eLeve felicidade para o mundo, visite orfanatos e mude o dia de muitas crianças. NLW#3\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003e \n\tVersão 1.0 🚀\n\u003c/h4\u003e\n\n\u003ch4 align=\"center\"\u003e \n\t🚧 Versão 2.0 em desenvolvimento 🚧\n\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n \u003ca href=\"#-sobre\"\u003eSobre\u003c/a\u003e •\n \u003ca href=\"#-layout\"\u003eLayout\u003c/a\u003e •\n \u003ca href=\"#features-implementadas-da-versão\"\u003eFeatures versão 2.0\u003c/a\u003e •\n \u003ca href=\"#-rotas-do-backend\"\u003eRotas do Backend\u003c/a\u003e • \n \u003ca href=\"#-executando-o-happy\"\u003eComo executar\u003c/a\u003e • \n \u003ca href=\"#tecnologias\"\u003eTecnologias\u003c/a\u003e • \n \u003ca href=\"#como-contribuir\"\u003eComo contribuir\u003c/a\u003e • \n \u003ca href=\"#-licença\"\u003eLicença\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## 💡 Sobre\n\nEssa aplicação permite que, se você faz parte de um orfanato, cadastre ele no mapa e caso você queira visitar um orfanato e fazer o dia de muitas crianças mais feliz, este é o lugar que vai encontrar os orfanatos mais perto de você, na cidade do Rio de Janeiro.\n\nEste projeto foi construído durante a terceira edição do evento Next Level Week da [Rocketseat](https://rocketseat.com.br/).\n\n---\n\n## 🎨 Layout\n\n\n### Web\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Happy Web\" title=\"Happy Web\" src=\"./assets/landing.png\" width=\"400px\"\u003e\n\n  \u003cimg alt=\"Happy Web\" title=\"Happy Web\" src=\"./assets/orph-map.png\" width=\"400px\"\u003e\n  \n  \u003cimg alt=\"Happy Web\" title=\"Happy Web\" src=\"./assets/orph-details-1.png\" width=\"400px\"\u003e\n  \n  \u003cimg alt=\"Happy Web\" title=\"Happy Web\" src=\"./assets/orph-details-2.png\" width=\"400px\"\u003e\n  \n  \u003cimg alt=\"Happy Web\" title=\"Happy Web\" src=\"./assets/create-orph-1.png\" width=\"400px\"\u003e\n  \n  \u003cimg alt=\"Happy Web\" title=\"Happy Web\" src=\"./assets/create-orph-2.png\" width=\"400px\"\u003e\n\u003c/p\u003e\n\n### Mobile\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Happy Mobile\" title=\"Happy Mobile\" src=\"./assets/splash-screen-mobile.png\" width=\"300px\"\u003e\n  \n  \u003cimg alt=\"Happy Mobile\" title=\"Happy Mobile\" src=\"./assets/orph-map-mobile-1.png\" width=\"300px\"\u003e\n  \n  \u003cimg alt=\"Happy Mobile\" title=\"Happy Mobile\" src=\"./assets/select-local.png\" width=\"300px\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Happy Mobile\" title=\"Happy Mobile\" src=\"./assets/create-orph.png\" width=\"300px\"\u003e\n  \n  \u003cimg alt=\"Happy Mobile\" title=\"Happy Mobile\" src=\"./assets/orph-details.png\" width=\"300px\"\u003e\n\u003c/p\u003e\n\n---\n\n\u003ch2 id=\"features-implementadas-da-versão\"\u003e 🚧 Features implementadas da Versão 2.0 \u003c/h2\u003e\n\n#### Web\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Happy Mobile\" title=\"Happy Web\" src=\"./assets/success-regis.png\" width=\"600px\"\u003e\n\u003c/p\u003e\n\n#### Mobile\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Happy Mobile\" title=\"Happy Mobile\" src=\"./assets/splash-screen-mobile.png\" width=\"300px\"\u003e \n  \u003cimg alt=\"Happy Mobile\" title=\"Happy Mobile\" src=\"./assets/success-regis-mobile.png\" width=\"300px\"\u003e\n\u003c/p\u003e\n\n\n---\n\n## 🍃 Rotas do Backend\n\nGET - http://localhost:3333/orphanages --\u003e Lista todos os orfanatos \u003cbr\u003e\nGET - http://localhost:3333/orphanages/:id --\u003e Lista um orfanato\u003cbr\u003e\nPOST - http://localhost:3333/orphanages --\u003e Cadastra um novo orfanato\u003cbr\u003e\n\n---\n\n## 💻 Executando o Happy\n\n### Pré-requisitos\n\nÉ necessário ter instalado na sua máquina para execução desse projeto:\n- NodeJS\n- Gerenciador de pacotes (Npm ou Yarn)\n\n### ♊ Clonando o Repositório\n\n```bash\n\n$ git clone https://github.com/heyloh/happy.git\n\n# entre na pasta do projeto\n\n$ cd happy\n\n```\n### 💻 Rodando o Happy web\n\nEntre na pasta\n\n```bash\n\n$ cd web\n\n```\nInstale as dependências\n\n```bash\n\n$ yarn\n\n# ou, caso use npm\n\n$ npm install\n\n```\n\nRode a aplicação\n\n```bash\n\n$ yarn start\n\n# ou, caso use npm\n\n$ npm start\n\n```\n\nCaso você tenha uma conta no [mapbox](https://www.mapbox.com/), pode usar seu token para utilizar o mapa da aplicação. No entanto, se você não quiser \nter este trabalho, sem problemas, por padrão já tem um mapa configurado para uso.\n\nCaso queira, vá para a seção do \u003ca href=\"#-mapbox\"\u003eMapbox\u003c/a\u003e.\n\n### 🌐 Rodando o Servidor\n\nEntre na pasta\n\n```bash\n\n$ cd backend\n\n```\nInstale as dependências\n\n```bash\n\n$ yarn\n\n# ou, caso use npm\n\n$ npm install\n\n```\n\nRode o servidor\n\n```bash\n\n$ yarn dev\n\n# ou, caso use npm\n\n$ npm dev\n\n```\n\n### 📱 Rodando o Happy mobile \n\nEntre na pasta\n\n```bash\n\n$ cd mobile\n\n```\nInstale as dependências\n\n```bash\n\n$ yarn\n\n# ou, caso use npm\n\n$ npm install\n\n```\n\nRode o mobile\n\n```bash\n\n$ yarn start\n\n# ou, caso use npm\n\n$ npm start\n\n```\n\nDepois de fazer isso, irá abrir o metro bundler no seu navegador. A partir de agora você tem algumas opções para acessar o app.\n\n#### 1 - Emulador Android\n Na página do metro bundler, clique em \"Run on Android device/emulator\" e espere carregar. Tenha em mente que é necessário ter passado pelo processo de instalação\n do android sdk, etc.\n\n#### 2 - Emulador IOS\n Na página do metro bundler, clique em \"Run on iOS simulator\" e espere carregar.\n \n#### 3 - Seu smartphone\n Baixe o aplicativo do Expo:\n  - [iOS](https://itunes.apple.com/app/apple-store/id982107779)\n  - [Android](https://play.google.com/store/apps/details?id=host.exp.exponent\u0026referrer=www)\n \n Depois de baixar, volte a página do metro bundler e escaneie o QR Code com o app do Expo.\n\n\u003cbr\u003e\n\nSe tudo deu certo, o app deve estar disponível agora! 👩🏽‍🔧\n\n---\n\n## 🗺 Mapbox\n\nSiga as instruções para usar o mapbox no lugar do openstreetmap.\n\n- Em \"https://account.mapbox.com/\", copie seu token.\n- Na raiz do projeto web crie um arquivo chamado \".env\"\n- Dentro desse arquivo, digite \"REACT_APP_MAPBOX_TOKEN =\" e cole seu token logo depois.\n- Entre no arquivo \"OrphanagesMap.tsx\", descomente o trecho de código correspondente as linhas 34, 35 e 36.\n- No mesmo arquivo, comente a linha 32.\n\nSe você fez tudo corretamente, estás usando a API do mapbox com seu Token na página do mapa. 😄\n\n---\n\n\u003ch2 id=\"tecnologias\"\u003e 🛠️ Tecnologias \u003c/h2\u003e\n\nAs ferramentas usadas no desenvolvimento do projeto.\n\n#### Backend:\n - Typescript\n - NodeJS\n - Express\n - Express Async Errors\n - TypeORM\n - SQLite\n - Multer\n - Yup\n - Cors\n\n#### Web:\n- Typescript\n- ReactJS ⚛️\n- React Router Dom\n- React Icons\n- Leaflet 🍃\n- API do Mapbox 🗺️\n- Axios\n\n#### Mobile:\n- Typescript\n- React Native\n- React Native Maps\n- React Navigation\n- React Navigation Stack\n- Expo\n- Expo Fonts\n- Expo Google Fonts - Nunito\n\n\n---\n\n\u003ch2 id=\"como-contribuir\"\u003e ⚙️ Como contribuir \u003c/h2\u003e\n\n- Faça um fork desse repositório;\n- Crie uma branch com a sua feature: `git checkout -b minha-feature`;\n- Faça commit das suas alterações: `git commit -m 'feat: Minha nova feature'`;\n- Faça push para a sua branch: `git push origin minha-feature`.\n\n---\n\n## 📝 Licença\n\nEste projeto está sob licença [MIT](./LICENSE).\n\n\u003cp\u003eFeito com 💙 por Lohana Torres\u003c/p\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheyloh%2Fhappy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheyloh%2Fhappy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheyloh%2Fhappy/lists"}