Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matheusfelipeog/happy
Plataforma online para encontrar orfanatos e facilitar visitas. @Rocketseat
https://github.com/matheusfelipeog/happy
event happy next-level-week next-level-week-3 nlw nlw-3 nodejs omnistack orfanato rocketseat
Last synced: 19 days ago
JSON representation
Plataforma online para encontrar orfanatos e facilitar visitas. @Rocketseat
- Host: GitHub
- URL: https://github.com/matheusfelipeog/happy
- Owner: matheusfelipeog
- License: mit
- Created: 2020-10-12T13:57:14.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-19T15:58:09.000Z (about 4 years ago)
- Last Synced: 2024-12-02T09:02:58.264Z (29 days ago)
- Topics: event, happy, next-level-week, next-level-week-3, nlw, nlw-3, nodejs, omnistack, orfanato, rocketseat
- Language: TypeScript
- Homepage: https://nextlevelweek.com/episodios/omnistack/1/edicao/3
- Size: 2.09 MB
- Stars: 25
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 📌 Index
- [Sobre o projeto](#-sobre-o-projeto)
- [Screenshots](#-screenshots)
- [Techs](#-techs)
- [Instalação e Start](#-instalação-e-start)
- [Contribuições](#-contribuições)
- [License](#-license)
## ❔ Sobre o projeto
Uma plataforma para facilitar o encontro de orfanatos por pessoas que querem visita-los.
O projeto está em desenvolvimento na [Next Level Week 3](https://nextlevelweek.com/episodios/omnistack/1/edicao/3)
## 📸 Screenshots
Tela Web
## 🛠 Techs
- **Web**
- [React](https://reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Leaflet](https://leafletjs.com/)
- [React Leaflet](https://react-leaflet.js.org/)
- [Open Street Map](https://www.openstreetmap.org/) ou [Mapbox](https://www.mapbox.com/)
- [Framer Motion](https://www.framer.com/motion/)
- **Backend**
- [Nodejs](https://nodejs.org/en/)
- [Express](https://expressjs.com/)
- [Typeorm](https://typeorm.io/)
- [Multer](https://github.com/expressjs/multer)
- [Yup](https://github.com/jquense/yup)
## ⚙ Instalação e Start
Este repositório é um monorepo, portanto, manterá os fontes do projeto **Web**, **API** e **Mobile**. Cada parte do projeto tem suas dependências e é necessário instala-las individualmente antes da execução, para isso certifique-se de que tenha [NPM](https://www.npmjs.com/) ou [YARN](https://yarnpkg.com/) instalado em seu ambiente, além, é claro, o repositório clonado em seu ambiente.
Clone o repositório com:
```bash
> git clone https://github.com/matheusfelipeog/happy.git
```
As demonstrações utilizam **YARN** por padronização, mas, caso use **NPM**, basta substituir onde estiver escrito `yarn` por `npm`.
**Instalando dependências do projeto web:**
```bash
> cd happy/web
> yarn install
```
Para executar o projeto **web** completo é necessário ter um **token** de autenticação da API do Mapbox. Acesse sua conta no site e crie um token para ser utilizado no projeto. Com o token em mãos, crie um arquivo `.env` e coloque seu token como valor da chave `REACT_APP_MAPBOX_TOKEN`.
Exemplo:
```text
REACT_APP_MAPBOX_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
Agora starte o projeto em seu ambiente com:
```bash
> yarn start
```
Acesse: [`http://127.0.0.1:3000/`](http://127.0.0.1:3000/) para visualizar.
**Instalando dependências do projeto backend:**
```bash
> cd happy/backend
> yarn install
```
Para executar o projeto **backend** é necessário criar o banco de dados com todas as tabelas utilizadas, para isso, use no diretório correspondente:
```bash
> yarn typeorm migration:run
> yarn dev
```
Acesse: [`http://127.0.0.1:3333/`](http://127.0.0.1:3333/) para visualizar.
## 🤝 Contribuições
Siga os passos abaixo para contribuir:
1. Faça o *fork* do projeto ()
2. Clone o seu *fork* para sua maquína (`git clone https://github.com/user_name/happy.git`)
3. Crie uma *branch* para realizar sua modificação (`git checkout -b feature/name_new_feature`)
4. Adicione suas modificações e faça o *commit* (`git commit -m "Descreva sua modificação"`)
5. *Push* (`git push origin feature/name_new_feature`)
6. Crie um novo *Pull Request*
7. Pronto, agora só aguardar a análise 🚀
## 📜 License
O projeto está sobre a licença [MIT](./LICENSE) ❤️
Gostou? Deixe uma estrelinha para ajudar o projeto ⭐