https://github.com/heyloh/happy
Leve felicidade para o mundo, visite orfanatos e mude o dia de muitas crianças. NLW#3
https://github.com/heyloh/happy
expo happy nlw-3 nodejs react-native reactjs typeorm typescript
Last synced: about 1 year ago
JSON representation
Leve felicidade para o mundo, visite orfanatos e mude o dia de muitas crianças. NLW#3
- Host: GitHub
- URL: https://github.com/heyloh/happy
- Owner: heyloh
- License: mit
- Created: 2020-10-12T14:08:14.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-03T19:15:00.000Z (over 5 years ago)
- Last Synced: 2025-04-10T23:03:09.692Z (about 1 year ago)
- Topics: expo, happy, nlw-3, nodejs, react-native, reactjs, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 7.67 MB
- Stars: 16
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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 🚧
Sobre •
Layout •
Features versão 2.0 •
Rotas do Backend •
Como executar •
Tecnologias •
Como contribuir •
Licenç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](https://rocketseat.com.br/).
---
## 🎨 Layout
### Web
### Mobile
---
🚧 Features implementadas da Versão 2.0
#### Web
#### 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
```bash
$ git clone https://github.com/heyloh/happy.git
# entre na pasta do projeto
$ cd happy
```
### 💻 Rodando o Happy web
Entre na pasta
```bash
$ cd web
```
Instale as dependências
```bash
$ yarn
# ou, caso use npm
$ npm install
```
Rode a aplicação
```bash
$ yarn start
# ou, caso use npm
$ npm start
```
Caso 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
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
```bash
$ cd backend
```
Instale as dependências
```bash
$ yarn
# ou, caso use npm
$ npm install
```
Rode o servidor
```bash
$ yarn dev
# ou, caso use npm
$ npm dev
```
### 📱 Rodando o Happy mobile
Entre na pasta
```bash
$ cd mobile
```
Instale as dependências
```bash
$ yarn
# ou, caso use npm
$ npm install
```
Rode o mobile
```bash
$ 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:
- [iOS](https://itunes.apple.com/app/apple-store/id982107779)
- [Android](https://play.google.com/store/apps/details?id=host.exp.exponent&referrer=www)
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](./LICENSE).
Feito com 💙 por Lohana Torres