https://github.com/caiogmrocha/happy
🧒 Projeto Criado Durante a NLW #03
https://github.com/caiogmrocha/happy
happy nextlevelweek nextlevelweek3 nlw-3 node-js reactjs rocketseat typescript
Last synced: 3 months ago
JSON representation
🧒 Projeto Criado Durante a NLW #03
- Host: GitHub
- URL: https://github.com/caiogmrocha/happy
- Owner: caiogmrocha
- License: mit
- Created: 2020-10-15T20:21:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-22T18:31:10.000Z (over 5 years ago)
- Last Synced: 2025-12-27T23:58:38.335Z (6 months ago)
- Topics: happy, nextlevelweek, nextlevelweek3, nlw-3, node-js, reactjs, rocketseat, typescript
- Language: TypeScript
- Homepage:
- Size: 204 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🚧 ... Em Construção ... 🚧
## 💻 Sobre o Projeto
**👧👦 Happy:** é um site que facilita o encontro de orfanatos para marcação de visitas ou consulta.
## :atom: Ferramentas
- **[ReactJS](https://pt-br.reactjs.org/)**
- **[React Native](https://reactnative.dev/)**
- **[Node JS](https://nodejs.org/en/)**
- **[Expo](https://expo.io/)**
- **[TypeScript](https://www.typescriptlang.org/)**
## :atom: Bibliotecas Usadas
- **[Leaflet](https://leafletjs.com/)**/**[React Leaflet](https://react-leaflet.js.org/)** (Biblioteca de mapas para a Web)
- **[Express](https://expressjs.com/pt-br/)** (Construção de aplicações **Web** e **API's**)
- **[TypeORM](https://typeorm.io/#/)** (Fornece recursos relacionados a Banco de Dados)
- **[Yup](https://github.com/jquense/yup)** (Validação de dados)
- **[CORS](http://expressjs.com/en/resources/middleware/cors.html)** (Permite que outras aplicações possam acessar a API)
- **[Multer](https://github.com/expressjs/multer)** (Upload de Arquivos)
## 🚀 Começando
Neste tópico você irá encontrar as instruções para iniciar o projeto da maneira correta.
Primeiro clone este projeto usando os seguintes comandos no Terminal:
```bash
# Clone este repositório
$ git clone https://github.com/CaioGui123/Happy.git
```
### 🎲 Configurando Backend
Entre no diretório do Backend da aplicação com `cd backend`.
Agora vamos instalar as dependências:
```bash
# Instalando as dependências
$ yarn install
```
ou
```bash
# Instalando as dependências
$ npm install
```
Execute as Migrações:
```bash
# Rodando as Migrations
$ yarn typeorm migration:run
```
ou
```bash
# Rodando as Migrations
$ npm run typeorm migration:run
```
Crie um diretório chamado 'uploads' na raiz do projeto:
```bash
# Criando diretório
$ mkdir uploads
```
Inicie o Servidor:
```bash
# Iniciando o Servidor
$ yarn dev
```
ou
```bash
# Iniciando o Servidor
$ npm run dev
```
Com isso você podera acessar a API pela rota: **([http://localhost:3333](http://localhost:3333))**
### 🧭 Configurando Frontend
Entre no diretório do Frontend da aplicação com `cd web`.
Agora vamos baixar o React e outras dependências:
```bash
# Instalando as dependências
$ npm install
```
ou
```bash
# Instalando as dependências
$ yarn install
```
Agora você poderá acessar o site pela rota: **([http://localhost:3000](http://localhost:3000))**
## :pencil: Licença
Este projeto esta sobe a licença MIT.
Feito com 💜 👋