Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/varejaodacarne/happy
😀 Happy - Bring happiness to the world
https://github.com/varejaodacarne/happy
leaflet nlw-3 nodejs reactjs rocketseat typescript
Last synced: about 1 month ago
JSON representation
😀 Happy - Bring happiness to the world
- Host: GitHub
- URL: https://github.com/varejaodacarne/happy
- Owner: VarejaoDaCarne
- License: mit
- Created: 2020-10-12T11:24:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T23:52:50.000Z (about 2 years ago)
- Last Synced: 2024-11-11T14:18:32.831Z (3 months ago)
- Topics: leaflet, nlw-3, nodejs, reactjs, rocketseat, typescript
- Language: TypeScript
- Homepage:
- Size: 5.65 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🙂 Leve felicidade para o mundo.
🚧 Happy 🙂 Concluído 🚧
Sobre •
Layout •
Como executar •
Tecnologias •
Autor •
Licença
## 💻 Sobre o projeto
🙂 Happy - A proposta do projeto é uma aplicação que possa facilitar visitas aos orfanatos próximos a você.
Projeto desenvolvido durante a **NLW - Next Level Week#03** oferecida pela [Rocketseat](https://rocketseat.com.br/).
---
## 🎨 Layout
### Mobile
### Web
---
## 🚀 Como executar o projeto
Este projeto é divido em três partes:
1. Backend (pasta backend)
2. Frontend (pasta web)
3. Mobile (pasta mobile)
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/).
Além disto ter um editor para trabalhar com o código como [VSCode](https://code.visualstudio.com/)
#### 🎲 Rodando o Backend
```bash
# Clone este repositório
$ git clone https://github.com/grioos/happy
# Acesse a pasta do projeto no seu terminal/cmd
$ cd happy
# Vá para a pasta backend
$ cd backend
# Instale as dependências
$ yarn
# Execute a aplicação
$ yarn dev
# O servidor inciará na porta:3333 - acesse http://localhost:3333
```
#### 🧭 Rodando a aplicação web
```bash
# Clone este repositório
$ git clone https://github.com/grioos/happy
# Acesse a pasta do projeto no seu terminal/cmd
$ cd happy
# Vá para a pasta da aplicação Front End
$ cd web
# Instale as dependências
$ yarn
# Execute a aplicação
$ yarn start
# A aplicação será aberta na porta:3000 - acesse http://localhost:3000
```
#### 📱 Rodando a aplicação mobile
```bash
# Clone este repositório
$ git clone https://github.com/grioos/happy
# Acesse a pasta do projeto no seu terminal/cmd
$ cd happy
# Vá para a pasta da aplicação Front End
$ cd mobile
# Instale as dependências
$ yarn
# Execute a aplicação
$ yarn start
# Uma página com QR code abrirá onde você pode scanear com seu aparelho ou abrir com seu emulador
```
---
## 🛠 Tecnologias
As seguintes ferramentas foram usadas na construção do projeto:
#### **Server** ([NodeJS](https://nodejs.org/en/) + [TypeScript](https://www.typescriptlang.org/))
- **[Express](https://expressjs.com/)**
- **[Multer](https://github.com/expressjs/multer)**
- **[Typeorm](https://typeorm.io/#/)**
- **[Yup](https://github.com/jquense/yup)**
- **[Express Async Errors](https://www.npmjs.com/package/express-async-errors)**
- **[CORS](https://expressjs.com/en/resources/middleware/cors.html)**
- **[KnexJS](http://knexjs.org/)**
- **[SQLite](https://github.com/mapbox/node-sqlite3)**
- **[Ts-node](https://github.com/TypeStrong/ts-node)**
> Veja o arquivo [package.json](https://github.com/grioos/happy/blob/master/backend/package.json)
#### **Website** ([React](https://reactjs.org/) + [TypeScript](https://www.typescriptlang.org/))
- **[React Router Dom](https://github.com/ReactTraining/react-router/tree/master/packages/react-router-dom)**
- **[React Icons](https://react-icons.github.io/react-icons/)**
- **[Axios](https://github.com/axios/axios)**
- **[Leaflet](https://leafletjs.com/)**
- **[React Leaflet](https://react-leaflet.js.org/)**
- **[React Dom](https://pt-br.reactjs.org/docs/react-dom.html)**
- **[React Scripts](https://github.com/facebook/create-react-app/tree/master/packages/react-scripts)**
> Veja o arquivo [package.json](https://github.com/grioos/happy/blob/master/web/package.json)
#### **Mobile** ([React Native](http://www.reactnative.com/) + [TypeScript](https://www.typescriptlang.org/))
- **[Expo](https://expo.io/)**
- **[Expo Font](https://www.npmjs.com/package/expo-font)**
- **[Expo StatusBar](https://docs.expo.io/versions/latest/sdk/status-bar/)**
- **[React Navigation](https://reactnavigation.org/)**
- **[React Native Maps](https://github.com/react-native-community/react-native-maps)**
- **[React Dom](https://github.com/facebook/react/tree/master/packages/react-dom)**
- **[React Native Gesture Handler](https://github.com/software-mansion/react-native-gesture-handler)**
- **[React Native Maps](https://github.com/react-native-maps/react-native-maps)**
- **[React Native Reanimated](https://github.com/software-mansion/react-native-reanimated)**
- **[React Native Safe Area Context](https://github.com/th3rdwave/react-native-safe-area-context)**
- **[React Native Screens](https://github.com/software-mansion/react-native-screens)**
- **[Axios](https://github.com/axios/axios)**
- **[Expo Status Bar](https://www.npmjs.com/package/expo-status-bar)**
> Veja o arquivo [package.json](https://github.com/grioos/happy/blob/master/mobile/package.json)
---
## 💪 Como contribuir para o projeto
1. Faça um **fork** do projeto.
2. Crie uma nova branch com as suas alterações: `git checkout -b my-feature`
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: `git commit -m "feature: My new feature"`
4. Envie as suas alterações: `git push origin my-feature`
---
## 🦸 Autor
Gabriel Rios 🚀
[](https://www.linkedin.com/in/grioos/)
[](mailto:[email protected])
---
## 📝 Licença
Este projeto esta sobe a licença [MIT](./LICENSE).
Feito por Gabriel Rios 👋🏻 [Entre em contato!](https://www.linkedin.com/in/grioos/)