An open API service indexing awesome lists of open source software.

https://github.com/9de/mindful-journal

📔 A privacy-focused journaling web app with markdown support, mood tracking, and tag organization. Write mindfully, reflect daily. ✨
https://github.com/9de/mindful-journal

Last synced: about 1 year ago
JSON representation

📔 A privacy-focused journaling web app with markdown support, mood tracking, and tag organization. Write mindfully, reflect daily. ✨

Awesome Lists containing this project

README

          

# 📔 Mindful Journal

![Mindful Journal Banner](https://raw.githubusercontent.com/9de/Mindful-Journal/main/assets/banner.png)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Stars](https://img.shields.io/github/stars/9de/Mindful-Journal?style=social)](https://github.com/9de/Mindful-Journal/stargazers)
[![Forks](https://img.shields.io/github/forks/9de/Mindful-Journal?style=social)](https://github.com/9de/Mindful-Journal/network/members)

*A beautiful, intuitive journaling web application for mindful self-reflection* ✨

[Features](#-features) • [Demo](#-demo) • [Installation](#-installation) • [Usage](#-usage) • [Roadmap](#️-roadmap) • [Contributing](#-contributing)

## ✨ Features

- 📝 **Rich Text Formatting**: Markdown support for headers, bold, italic, and lists
- 🏷️ **Smart Tagging**: Organize entries with #hashtags
- 😊 **Mood Tracking**: Record your daily emotional state
- 🔍 **Quick Search**: Find entries by content or tags
- 📊 **Progress Tracking**: Monitor your writing streak
- 💾 **Auto-Save**: Never lose your thoughts with automatic draft saving
- ⌨️ **Keyboard Shortcuts**: Efficient writing with keyboard support
- 📱 **Responsive Design**: Perfect on any device

## 🚀 Demo

Visit the live demo: [Mindful Journal Demo](https://9de.github.io/Mindful-Journal/)

## 💻 Installation

1. Clone the repository:
```bash
git clone https://github.com/9de/Mindful-Journal.git
```

2. Navigate to the project directory:
```bash
cd Mindful-Journal
```

3. Open `index.html` in your preferred browser.

## 🎯 Usage

1. **Start Writing**: Click the text area and begin your journal entry
2. **Format Text**: Use the toolbar or keyboard shortcuts:
- `Ctrl/Cmd + B`: Bold
- `Ctrl/Cmd + I`: Italic
- `Ctrl/Cmd + S`: Save entry
3. **Add Tags**: Include #hashtags in your text to categorize entries
4. **Set Mood**: Select an emoji that matches your current mood
5. **Save**: Click the save button or use `Ctrl/Cmd + S`

## 🛣️ Roadmap

Here are some planned improvements and features:

### Short-term Goals
- [ ] Dark mode support
- [ ] Export entries to PDF/Markdown
- [ ] Multiple journal categories
- [ ] Rich text editor enhancements
- [ ] Custom mood emoji support

### Long-term Vision
- [ ] Cloud sync capabilities
- [ ] Mobile app version
- [ ] AI-powered insights
- [ ] Templates for different journal types
- [ ] Collaboration features for shared journals
- [ ] End-to-end encryption
- [ ] Custom themes and styling
- [ ] Journal prompts and inspiration
- [ ] Integration with mental health resources
- [ ] Voice-to-text entry support

## 🤝 Contributing

Contributions are welcome! Here's how you can help:

1. Fork the repository
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

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

- Font Awesome for the beautiful icons
- The open-source community for inspiration
- All contributors who help improve this project

---


Made with ❤️ for mindful journaling

[Report Bug](https://github.com/9de/Mindful-Journal/issues) • [Request Feature](https://github.com/9de/Mindful-Journal/issues)