Skip to content

Latest commit

 

History

History
131 lines (86 loc) · 3.99 KB

README.md

File metadata and controls

131 lines (86 loc) · 3.99 KB

Happy



GitHub language count GitHub Top Language License GitHub last commit

Happy

Tópicos

Sobre o Happy

Tecnologias

Instalação e uso

Licença


Sobre o Happy

Happy é uma aplicação Web com o objetivo de conectar Pessoas a Orfanatos infantis. Essa aplicação oferece aos Orfanatos a possibilidade de cadastrar seus respectivos dados, tais como: nome, endereço, descrição, horário de funcionamento e imagens do local. As pessoas tem a possibilidade de visualizar no map os endereços e detalhes dos orfanatos.

O Happy foi desenvolvida durante a #NLW3 (Next Level Week 3º Edição) da Rocketseat.


Página inicial

Tecnologias


Instalação e Uso

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 ou YARN instalado em seu ambiente, além, é claro, o repositório clonado em seu ambiente.

Clone o repositório com:

> git clone https://github.com/wanderon1873/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:

> 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_MAP_TOKEN.

Exemplo:

REACT_APP_MAP_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Agora starte o projeto em seu ambiente com:

> yarn start

Acesse: http://127.0.0.1:3000/ para visualizar.


Instalando dependências do projeto backend:

> 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:

> yarn typeorm migration:run
> yarn dev

Acesse: http://127.0.0.1:3333/ para visualizar.


Licença

License

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.


Feito com 💜 by Wanderson Oliveira