Git Product home page Git Product logo

happy's Introduction

happy

Leve felicidade para o mundo, visite orfanatos e mude o dia de muitas crianças. NLW#3

Versão 1.0 🚀

🚧 Versão 2.0 em desenvolvimento 🚧

SobreLayoutFeatures versão 2.0Rotas do BackendComo executarTecnologiasComo contribuirLicença


💡 Sobre

Essa 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.

Este projeto foi construído durante a terceira edição do evento Next Level Week da Rocketseat.


🎨 Layout

Web

Happy Web Happy Web Happy Web Happy Web Happy Web Happy Web

Mobile

Happy Mobile Happy Mobile Happy Mobile

Happy Mobile Happy Mobile


🚧 Features implementadas da Versão 2.0

Web

Happy Mobile

Mobile

Happy Mobile Happy Mobile


🍃 Rotas do Backend

GET - http://localhost:3333/orphanages --> Lista todos os orfanatos
GET - http://localhost:3333/orphanages/:id --> Lista um orfanato
POST - http://localhost:3333/orphanages --> Cadastra um novo orfanato


💻 Executando o Happy

Pré-requisitos

É necessário ter instalado na sua máquina para execução desse projeto:

  • NodeJS
  • Gerenciador de pacotes (Npm ou Yarn)

♊ Clonando o Repositório

$ git clone https://github.com/heyloh/happy.git

# entre na pasta do projeto

$ cd happy

💻 Rodando o Happy web

Entre na pasta

$ cd web

Instale as dependências

$ yarn

# ou, caso use npm

$ npm install

Rode a aplicação

$ yarn start

# ou, caso use npm

$ npm start

Caso você tenha uma conta no mapbox, pode usar seu token para utilizar o mapa da aplicação. No entanto, se você não quiser ter este trabalho, sem problemas, por padrão já tem um mapa configurado para uso.

Caso queira, vá para a seção do Mapbox.

🌐 Rodando o Servidor

Entre na pasta

$ cd backend

Instale as dependências

$ yarn

# ou, caso use npm

$ npm install

Rode o servidor

$ yarn dev

# ou, caso use npm

$ npm dev

📱 Rodando o Happy mobile

Entre na pasta

$ cd mobile

Instale as dependências

$ yarn

# ou, caso use npm

$ npm install

Rode o mobile

$ yarn start

# ou, caso use npm

$ npm start

Depois de fazer isso, irá abrir o metro bundler no seu navegador. A partir de agora você tem algumas opções para acessar o app.

1 - Emulador Android

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 do android sdk, etc.

2 - Emulador IOS

Na página do metro bundler, clique em "Run on iOS simulator" e espere carregar.

3 - Seu smartphone

Baixe o aplicativo do Expo:

Depois de baixar, volte a página do metro bundler e escaneie o QR Code com o app do Expo.


Se tudo deu certo, o app deve estar disponível agora! 👩🏽‍🔧


🗺 Mapbox

Siga as instruções para usar o mapbox no lugar do openstreetmap.

  • Em "https://account.mapbox.com/", copie seu token.
  • Na raiz do projeto web crie um arquivo chamado ".env"
  • Dentro desse arquivo, digite "REACT_APP_MAPBOX_TOKEN =" e cole seu token logo depois.
  • Entre no arquivo "OrphanagesMap.tsx", descomente o trecho de código correspondente as linhas 34, 35 e 36.
  • No mesmo arquivo, comente a linha 32.

Se você fez tudo corretamente, estás usando a API do mapbox com seu Token na página do mapa. 😄


🛠️ Tecnologias

As ferramentas usadas no desenvolvimento do projeto.

Backend:

  • Typescript
  • NodeJS
  • Express
  • Express Async Errors
  • TypeORM
  • SQLite
  • Multer
  • Yup
  • Cors

Web:

  • Typescript
  • ReactJS ⚛️
  • React Router Dom
  • React Icons
  • Leaflet 🍃
  • API do Mapbox 🗺️
  • Axios

Mobile:

  • Typescript
  • React Native
  • React Native Maps
  • React Navigation
  • React Navigation Stack
  • Expo
  • Expo Fonts
  • Expo Google Fonts - Nunito

⚙️ Como contribuir

  • Faça um fork desse repositório;
  • Crie uma branch com a sua feature: git checkout -b minha-feature;
  • Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
  • Faça push para a sua branch: git push origin minha-feature.

📝 Licença

Este projeto está sob licença MIT.

Feito com 💙 por Lohana Torres

happy's People

Contributors

heyloh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.