An open API service indexing awesome lists of open source software.

https://github.com/vitorserrano/happy

😀 Next Level Week - #NLW3.0 by @Rocketseat: Aplicação para conectar pessoas a orfanatos
https://github.com/vitorserrano/happy

leaflet nodejs react-icons react-native react-router-dom reactjs typescript

Last synced: 6 months ago
JSON representation

😀 Next Level Week - #NLW3.0 by @Rocketseat: Aplicação para conectar pessoas a orfanatos

Awesome Lists containing this project

README

          


Happy


Conecte pessoas a orfanatos e traga felicidade as crianças.




Node.js version


Yarn version


Eslint style guide


Made by Rocketseat


LICENSE

## Conteúdo

- [Sobre](#sobre)
- [Documentação](#documentacao)
- [Tecnologias](#tecnologias)
- [Pré-requisitos](#pre-requisitos)
- [Como usar](#como-usar)
- [Como contibuir](#como-contribuir)

## :bookmark: Sobre

O Happy é uma aplicação Web e Mobile para que pessoas encontrem orfanatos perto de sua casa e leve mais felicidade para as crianças.

Essa aplicação foi construída na trilha OmniStack da Next Level Week 3.0 distribuída pela [Rocketseat](https://rocketseat.com.br/).

A ideia de criar uma aplicação voltada as crianças surgiu da coincidência da data do começo do evento cair no dia 12 de outubro, **dia das crianças**.

## :books: Documentação

Para reforçar alguns conceitos e registrar comandos que são dificeis de se lembrar eu fiz uma pequena **[DOCUMENTAÇÃO](DOCUMENTATION.md)** para ajudar quem esta iniciando com **TypeScript**, **Node**, **ReactJS** e **React Native**.

## :rocket: Tecnologias Utilizadas

O projeto foi desenvolvido utilizando as seguintes tecnologias

- [TypeScript](https://www.typescriptlang.org/)
- [Node.js](https://nodejs.org/en/)
- [ReactJS](https://reactjs.org/)
- [React Native](https://reactnative.dev/)

## :fire: **Pré-requisitos**

- [Node.js](https://nodejs.org/en/)
- [NPM](https://www.npmjs.com/) ou [Yarn](https://yarnpkg.com/)
- [Expo](https://expo.io/)

## :zap: Como usar

- Faça um clone desse repositório: `git clone https://github.com/vitorserrano/happy.git`
- Instale as dependências: `yarn install` ou `npm install`
- Inicie a aplicação:

- Servidor

- Entre na pasta: `cd server`
- Rode o comando de inicialização: `yarn start` ou `npm start`

- Web

- Entre na pasta: `cd web`
- Rode o comando de inicialização: `yarn start` ou `npm start`

- Mobile
- Entre na pasta: `cd web`
- Rode o comando de inicialização: `yarn start` ou `npm start`

## :recycle: Como contribuir

- Faça um Fork desse repositório,
- Crie uma branch com a sua feature: `git checkout -b my-feature`
- Commit suas mudanças: `git commit -m 'feat: My new feature'`
- Push a sua branch: `git push origin my-feature`

## :mortar_board: Quem ministrou?

As aulas foram ministradas pelo mestre **[Diego Fernandes](https://github.com/diego3g)** nas aulas da **Next Level Week**.

## :memo: License

Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE.md) para mais detalhes.

---


Feito com 💜 by Vitor Serrano