Sobre | O próximo nível | Tecnologias | Layout | Como executar | Como contribuir | Licença

💡 Sobre

Happy é um projeto que permite ao usuário cadastrar orfanatos, com o intuito de facilitar e promover visitas as instituições, fornecendo os dados necessários para encontrar e marcar visitas!

Esse projeto foi desenvolvido durante a terceira edição da Next Level Week, um evento da Rocketseat

🚀 O próximo nível

Desafios fornecidos pela rocketseat, entregues ao fim da semana NLW com o intuito de levar a aplicação para um próximo nível!

• Acesso restrito ✔️
  Área administrativa, com rotas autenticadas, e função lembrar-me.
• Recuperação de Senhas ✔️
  Envio de email, com link para a recuperação de senha.
• Cadastro Pendente ✔️
  O cadastro do orfanato fica como pendente, e só aparece no mapa, após a aprovação de um administrador.
• Localização real do usuário ✔️
  Pegar a localização real do usuário.
• Logout da aplicação ✔️
  Botão para sair da aplicação, limpando os dados no localStorage.

🔍 Tecnologias

Backend

• Typescript
• NodeJS
• Express
• Sendgrid
• Cors
• JWT
• Yup
• Bcrypt
• Typeorm
• PG

Frontend

• Typescript
• ReactJS
• React router dom
• React icon
• Axios
• Leaflet
• Styled Components

🎨 Layout

O layout foi desenvolvido por Tiago Luchtenberg e está disponível aqui

📌 Como executar

Você pode testar a aplicação neste link

Ou se quiser baixar, é só seguir estes passos:

1. Clonar respositório

Para clonar este repositório, digite o comando

$ git clone https://github.com/asleeplevi/happy.git

2. Instalar pacotes

Instale as dependências

$ yarn 

# ou se usar npm
    
$ npm install

3. Configurar variáveis ambiente

Abra o arquivo .env-example e coloque seu token de mapbox, caso não tenha, acesse aqui e crie uma conta gratuita. Por fim, altere o nome do arquivo para .env e continue para o próximo passo.

4. Iniciar aplicação

Inicie a aplicação com o comando

$ yarn start
  
# ou caso use npm
  
$ npm install

5. Acessar aplicação

E agora é so acessar sua aplicação que vai estar rodando em http://localhost:3000

Detalhe: A aplicação estará buscando as informações na minha API, que está rodando no heroku. O código desta API está disponível aqui

🔧 Como contribuir

• Faça um fork desse repositório.
• Crie uma branch:

git checkout -b my-feature

• Faça commit do seu código:

git commit -m 'my new feature'

• Faça push para a sua branch:

git push origin my-feature

📝 Licença

Este projeto está sob licença MIT.

Feito com 💙 por Levi