Tecnologias   |    Projeto   |    Backend   |    Frontend   |    Instalação   |    Como contribuir   |    Licença

---

💻 Projeto

Projeto desenvolvido durante a Mega Hack 3º Edição promovido pela empresa Shawee. O Casa na Árvore é uma solução criada para o desafio Árvore, onde visa amenizar o problema de falta/difícil conectividade e solucionar o problema da falta de interesse pela leitura, trazendo uma dinamica de gamificação para dentro do ambiente de leitura.

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

	TypeScript
	Node.js
	React
	Ionic
	Celebrate
	Knex
	Axios
	Express

🔨 Backend

O back-end foi construido com Node.js, todo escrito com TypeScript, que quando compilado gera code JavaScript puro.

O Express foi usado para lidar com as rotas de forma simples e eficaz, e foi aplicado o Cors assim possibilitando uma conexão mais segura e o Celebrate para validar as requisições.

Na autenticação geramos os hash das senhas com Bcryptjs e JsonWebToken para gerar os tokens de validação.

O Knex foi o ORM escolhido para o nosso gerenciamento com banco de dados que em ambiente de desenvolvimento esta sendo usado o SQLite3.

O Insomnia nos auxiliou para testar as requisições de nossas rotas.

📱 🌐 FrontEnd

Todo construído em React e escrito em TypeScript. Para obter a conexão com as api's esta sendo usado Axios. Na cosntrução da aplicação PWA, usamos o Ionic para acesso às API’s nativas e gerar componentes estilosos de maneira prática.

🔥 Instalação

# Clone este repositório
$ https://github.com/TadeuA/NLW-1https://github.com/josephpatrick1/casa-na-arvore.git

# Navegue até a pasta backend e execute os seguintes comandos:
$ yarn install or npm install
$ yarn knex:migrate or npm run knex:migrate
$ yarn knex:seed or npm run knex:seed
$ yarn dev or npm run dev
# Depois disso, entre na pasta frontend e execute os comandos:
$ yarn install or npm install
$ yarn start or npm run start

# Observações:
- Não esqueça de mudar a baseURL no arquivo api.ts das pastas web e mobile para o ip da sua máquina
- Para acessar a demo use o login de demonstração { email: [email protected], senha: 123456 }

🤔 Como contribuir

• Faça um clone desse repositório git clone https://github.com/josephpatrick1/casa-na-arvore.git;
• Cria uma branch com a sua feature: git checkout -b minha-feature;
• Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
• Faça push para da sua branch: git push git push --set-upstream origin minha-feature.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

🧾 Licença

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

---