Skip to content
Easy to use mobile Diary application built with flutter
Dart Ruby Other
Branch: master
Clone or download

README.md

📓 Dear Diary

PRs Welcome All Contributors

A diary application to pen down your thoughts

Overview

A diary app that connects to a REST API I built a while ago for managing personal diary entries.

See REST API project here

🚀 Technology Stack

  • Dart
  • Flutter

💡 Possible learnings

What I learnt (and you can learn) by building this project include but not limited to the following:

  • Simple approach to using provider (w/ ChangeNotifier) for managing app state
  • Working with REST APIs using dio package
  • Using get_it to access service objects
  • Custom Route transition (using PageRouteBuilder)
  • Simple Animations (example can be found in - view entry options menu)
  • Creating a Dialog service to prompt dialog outside a widget
  • Using IndexedStack to hold BottomNavigationBar Current View state

📸 Screenshots

Onboarding slide 1 Onboarding slide 2
Create Account Log In
Add/Edit entry Add entry success dialog
Entries List Profile screen
View entry w/ options Delete entry

📖 Things To do

There is still room for improvement

  • Add tests (Yeah, I know 😉)
  • Theming - Declare styles in a way that it's easy to change
  • Handle network status
  • Add reminder for daily reflections
  • Add offline persistence
  • Refractor as needed

Support

  • Show some ❤️ and ⭐️ the repo to encourage more useful OS projects

Contributing

The sole purpose of this project is to facilate learning, PRs and all forms of contribution are very much welcome! Consider running REST API project locally during development.

Code of Conduct

Be nice and constructive ☺️. Don't be a jerk to others! 🚩

Contributors

Ogundiran Al-Ameen
Ogundiran Al-Ameen

💻 📖⚠️
rodrigobastosv
rodrigobastosv

💻

Credits

Random images generated from Unsplash

Entry PLaceholder Photo by Kelly Sikkemma on Unsplash

License

Under MIT license but don't forget to reference :).

Getting Started

For help getting started with Flutter, view the online documentation

You can’t perform that action at this time.