jpgtzg / self_blog

Open-source Flutter app for daily journaling and mental health tracking.
MIT License
0 stars 0 forks source link

Self Blog

Self Blog is an open-source Flutter application designed to help individuals document their daily lives, manage mental health, and create a personal and safe space for self-reflection. This app provides a platform for users to share their daily progress privately, helping them to cope with mental health issues and track their journey over time.

Features

Getting Started

Prerequisites

Installation

  1. Clone the Repository

    git clone https://github.com/jpgtzg/self_blog.git
    cd self_blog
  2. Install Dependencies

    flutter pub get
  3. Run the App

    flutter run

Usage

  1. Home Screen

    • View your recent entries.
    • Access the menu for additional options.
  2. Creating a Journal Entry

    • Tap the "+" button to create a new entry.
    • Write your thoughts and select your mood.
    • Save the entry to store it locally.
  3. Viewing Past Entries

    • Use the calendar view to navigate through past entries.
    • Tap on a date to view the entry for that day.
  4. Customizing the App

    • Access the settings from the menu.
    • Choose your preferred theme and set up daily reminders.

Contributing

We welcome contributions from the community! If you would like to contribute to Self Blog, please follow these steps:

  1. Fork the Repository

    Click the "Fork" button at the top of this repository to create a copy on your GitHub account.

  2. Clone Your Fork

    git clone https://github.com/jpgtzg/self_blog.git
    cd self_blog
  3. Create a Branch

    git checkout -b feature/your-feature-name
  4. Make Your Changes

    Implement your feature or bug fix.

  5. Commit Your Changes

    git add .
    git commit -m "Add your feature or fix description"
  6. Push to Your Fork

    git push origin feature/your-feature-name
  7. Create a Pull Request

    Open a pull request to the main branch of the original repository. Provide a detailed description of your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributors

If you have any questions, suggestions, or feedback, please feel free to open an issue or contact the project maintainer.


Thank you for using Self Blog! We hope it helps you on your journey to better mental health and self-awareness.