Next Level Week 3 - Happy

Projeto desenvolvido para a NLW3.

Leve felicidade para o mundo, visite casas de acolhimento institucional e mude o dia de muitas crianças.

O Happy é uma aplicação que conecta pessoas à casas de acolhimento institucional para fazer o dia de muitas crianças mais feliz.

Tabela de conteúdo

Feature
Aplicação web
Tecnologia
Arquitetura
Dependências
Dependências de desenvolvimento
Clonando o projeto
Iniciando a aplicação
Autor

Features

Página inicial com a lista dos orfanatos
Página com os detalhes do orfanato
Página de cadastro de um novo orfanato

Aplicação web

Inicialmente o projeto possui uma lista de orfanatos, detalhes e cadastro de orfanatos.

Imagem por Rocketseat

Tecnologia

O projeto foi desenvolvido com o ReactJS e Typescript.

Arquitetura

web
├── public/
│   ├── index.html
├── src/
│   ├── assets/
│   │   └── images
│   │       └── landing.svg
│   │       └── logo.svg
│   │       └── map-marker.svg
│   │   └── styles
│   │       └── GlobalStyles.ts
│   ├── components/
│   │   └── Location/
│   │       └── index.tsx
│   │       └── styles.ts
│   │   └── Sidebar/
│   │       └── index.tsx
│   │       └── styles.ts
│   ├── pages/
│   │   └── CreateOrphanage/
│   │       └── index.tsx
│   │       └── styles.ts
│   │   └── Landing/
│   │       └── index.tsx
│   │       └── styles.ts
│   │   └── Orphanages/
│   │       └── index.tsx
│   │       └── styles.ts
│   │   └── OrphanagesMap/
│   │       └── index.tsx
│   │       └── styles.ts
│   ├── services/
│   │   └── api.ts
│   ├── utils/
│   │   └── mapIcon.ts
│   ├── App.tsx
│   ├── index.tsx
│   ├── react-app-env.d.ts
│   └── routes.tsx
├── .editorconfig
├── .env
├── .eslintrc.json
├── .gitignore
├── .prettierrc.js
├── babel.config.js
├── config-overrides.js
├── package.json
├── README.md
├── tsconfig.json
├── tsconfig.paths.json
└── yarn.lock

Dependências

Dependências de desenvolvimento

Clonando o projeto

Baixe o projeto diretamente do GitHub ou use o terminal:

# Clone o repositório
$ git clone git@github.com:paesrafael/nlw3-happy-web.git

# Ou use a CLI do GitHub
$ gh repo clone paesrafael/nlw3-happy-web

# Acesse a pasta do projeto
$ cd nlw3-happy-web

# Instale as dependências
# Na raiz do projeto, use NPM ou YARN para instalar

# Usando YARN
$ yarn install

# Usando NPM
$ npm install

Iniciando a aplicação

Para começar use o comando:

# Usando YARN
yarn start

# Usando NPM
npm start

# Acesse a aplicação em http://localhost:3000

Autor

NLW3 - Happy desenvolvido por Rafael Paes