hstrada/hackathon-galho

Aplicativo para incentivar a leitura através da gamificação.

App made to inspire kids and transform the future through reading!

Index

• 🚀 Project Summary
• 👨‍💻️ Technologies Used
• 📦️ How to install the project
• 🤔️ How can you contribute?
• 🔮 Future Improvements

---

🚀 Project Summary

"O Galho é um aplicativo E-Reader que transforma a jornada literária do usuário em um grande jogo através de aspectos de gamificação, como níveis, conquistas, árvores de progresso e outros. Além disso, ao concluir um árvore de progresso, o leitor desbloqueará conteúdos adicionais sobre o livro lido e seu conteúdo, para que dessa forma o leitor possa voltar a dar valor a leitura. O Galho chegou para trazer aspectos que vêm crescendo no mercado de softwares para uma área que carece dos mesmos, possuindo uma grande escalabilidade em suas funções e em sua habilidade de tornar a leitura algo muito mais agradável, valioso e recompensador para os desmotivados jovens do Brasil."

This Project was made to MegaHack 3.0, to solve the challenge proposed by Árvore Educação company.

Release: https://github.com/hstrada/hackathon-galho/releases

---

👨‍💻️ Technologies Used

This project was developed using the technologies bellow:

Mobile

• React Native

Dependencies

• Typescript
• Styled Components
• React Native PDF
• Redux
• Redux-Saga
• Reactotron
• Husky
• Jest

Code patterns

• ESLint

Code patterns

• Commitlint

IDE

• Visual Studio Code

---

📦️ How to install the project

Node.js and Yarn or NPM are required

To clone the project, use the commands bellow:

  # Clone the repository
  ❯ git clone https://github.com/hstrada/hackathon-galho.git

  # Enter directory
  ❯ cd hackathon-galho

Mobile

Emulate in IOS

  # Enter mobile directory
  > cd Galho

  # Install the dependencies
  ❯ yarn

  # Install the IOS dependencies
  ❯ npx pod-install ios
  
  # Install and start the project
  ❯ yarn ios

Emulate in Android

  # Enter mobile directory
  > cd Galho

  # Install the dependencies
  ❯ yarn
  
  # Install and start the project
  ❯ yarn android

---

🤔️ How can you contribute?

1. fork this repository
2. Create a branch with your feature:
   • $ git checkout -b my_feature
3. Commit your branch:
   • $ git commit -m "feature: My new feature"
4. Submit your branch:
   • $ git push origin my_feature

---

🔮 Future Improvements

• Dictionary
• Reading Settings (font, size, theme, etc)
• Add Gifs, Images and Videos
• Teach about reading benefits
• Add audiobooks for low vision or blind people
• Add Streaming technique to load ebooks
• Q&A
• Battle games with friends

---

Made with 💚 by Helena Strada, Josias Calebe and Matheus Santos! We hope you love it!