rainzoneg / well_app

😀 improve your productivity and long-term happiness in just 21 days.

---

Quick Links

---

The Well app is available for download! 🥳 🚀

• iOS/macOS: Search for "well: reboot your mindset" on the iOS app store.
• Web: Visit https://well-app.netlify.app. Install as a PWA for native-like functionality!
• Android: coming soon 👀

---

PROJECT PHILOSOPHY • WIKI • TECH STACK • CONTRIBUTING • SPREAD THE WORD • LICENSE

🧐 Project philosophy

The Well app is a mental health and mindfulness app built on top of the science of positive psychology. The Well app is more than just another meditation or journaling app; it encourages you to enhance and reflect on your day with structured, guided activities.

There are 5 daily tasks that the Well app asks you to complete each day: record 3 gratitudes, write a journal entry, perform 3 acts of kindness, exercise for 20 minutes, and meditate for 15 minutes.

Read more about the Well app on the project homepage.

📒 Wiki

This project repository has a great wiki (currently WIP) that you should consider reading! It goes into detail about the project from a more technical aspect. If you are interested in learning more about the app itself, go ahead and check it out!

👨‍💻 Tech stack

Here's a brief high-level overview of the tech stack the Well app uses:

• This project uses the Flutter app development framework. Flutter is a cross-platform hybrid app development platform which allows us to use a single codebase for apps on mobile, desktop, and the web.
• For persistent storage (database), the app uses the Hive package which allows the app to create a custom storage schema and save it to a local database.
• To send local push notifications, the app uses the flutter_local_notifications package which supports Android, iOS, and macOS.
  • 🚨 Currently, notifications aren't working on macOS. This is a known issue that we are working to resolve!
• The app uses the font "Work Sans" as its main font, and the design of the app adheres to the material design guidelines.

For more information on the technologies that power the Well app, check out the Tech Stack page on our wiki.

✍️ Contributing

Interested in contributing to the Well app project? Thanks so much for your interest! We are always looking for improvements to the project and contributions from open-source developers are greatly appreciated.

If you have a contribution in mind, please check out our Contribution Guide for information on how to do so. Also, make sure you read our Code of Conduct to foster an encouraging sense of community.

🌟 Spread the word!

If you want to say thank you and/or support active development of the Well app:

• Add a GitHub Star to the project!
• Tweet about the project on your Twitter!
  • Tag @colegawin_ and/or #thewellapp
• Leave us a review on the iOS App Store!

Thanks so much for your interest in growing the reach of the Well app!

PS: consider sponsoring me (Cole Gawin) to continue the development of this project on BuyMeACoffee :)

⚠️ License

The Well app is free and open-source software licensed under the GNU General Public License v3.0. All designs were created by Cole Gawin and distributed under Creative Commons license (CC BY-SA 4.0 International).

---

💛

Reminder that you are great, you are enough, and your presence is valued. If you are struggling with your mental health, please reach out to someone you love and consult a professional. There are many resources for you to get help in a time of need.