Skip to content

Latest commit

 

History

History
122 lines (101 loc) · 5.39 KB

README.md

File metadata and controls

122 lines (101 loc) · 5.39 KB
Raw

Starbook ⭐️

A digital diary that can help you in keeping track of your mood and productivity throughout the month. Mood tracker is a good way to see how you are mostly feeling. And it helped me a lot to realise how my general mood is and to improve it. Cause I was feeling down two years ago so now when I look at my mood board it looks much nicer.

About Me · Report Bug · Request Feature

Twitter Follow GitHub license Flutter Version

Get the App

📝 About the App

“StarBook” is a digital diary, and a mood tracking app. The user will be able to rate his mood for each day and write a short story for him, like how his day was. Color is given to each mood, let’s say, green for a happy mood, red for angry and yellow for a sad mood. The statistics of users will be visualized in a methodical structure. For this the app will form a graph, calendar, each date box is colored with the color of users' aura lets say green for positive spirits. StarBook will cooperate with users to boost their positive energy and train healthy thinking, correspondingly moving towards calmer and patient personality. StarBook will use positive psychology and cognitive behavioral therapy for you to better understand yourself, overcoming stress, anxiety, and depressions. The app is all in all focused to give personalized experience to every individual user, increasing their productivity, objectivity, and emotional health.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisite: https://flutter.dev/docs/get-started/install

  1. To get started, fork this repository to your GitHub account.

  2. Clone the repo.

     git clone https://github.com/<your-username>/star_book.git

  3. Install packages.

     flutter pub get

Run project

  • Run project on development. 
     flutter run --dart-define=flavor=dev
  • Run project in staging(debug mode). 
    flutter run --dart-define=flavor=qa
  • Run project in production. 
      flutter run --dart-define-from-file=.env.prod.json

Deploy project

  • Deploy to iOS. 
    flutter build ipa --release --dart-define-from-file=.env.prod.json
  • Deploy to Android. 
    flutter build appbundle --release --dart-define-from-file=.env.prod.json

where .env.prod.json is the file containing the production environment variables as like the following.

{
  "flavor": "prod",
  "apiKey": "<FIREBASE_API_KEY>",
  "appIdAndroid": "<FIREBASE_APP_ID>",
  "appIdIos": "<FIREBASE_APP_ID>",
  "messagingSenderId": "<FIREBASE_MESSAGING_SENDER_ID>",
  "projectId": "<FIREBASE_PROJECT_ID>",
  "storageBucket": "<FIREBASE_STORAGE_BUCKET>",
  "iosBundleId": "<IOS_BUNDLE_ID>",
}

Support my work

If you found this project valuable, please consider giving it a ⭐️ on GitHub. Your support keeps me motivated! If you'd like to further support my work, you can buy me a book. Thank you for your generosity!

🤝 Contributing

Are you interested in building and contributing to this awesome app? Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. To pick something for contribution refer StarBook board. For more, refer CONTRIBUTING.md

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.