Skip to content

Latest commit

 

History

History
63 lines (33 loc) · 2.78 KB

README.md

File metadata and controls

63 lines (33 loc) · 2.78 KB
Raw

Overview

MindFlow is a unique platform designed to help you clear your mind and unleash your creativity through the power of expressive writing. Screenshot 2023-10-12 at 14 04 59

Features

Local Storage

MindFlow securely stores your thoughts locally in localStorage. This means that your writings are saved on your device, providing you with privacy and a seamless writing experience. Your thoughts are easily accessible whenever you return to the platform, allowing you to pick up where you left off.

Shortcut Controls

MindFlow integrates intuitive shortcut controls to provide you with a seamless and efficient writing experience. These shortcuts include:

  • Toggle Blur (Shortcut: B): Quickly switch the blur effect on or off to create a clear and focused writing environment.

  • Search Your Thoughts (Shortcut: ⌘ + F): Easily search your writings with a simple key combination, making it effortless to find and organize your ideas.

  • Toggle Theme (Shortcut: T): Customize your writing ambiance by switching between light and dark themes with the press of a key.

  • Clear Thoughts: Start anew by clearing your thoughts, allowing space for fresh ideas and inspiration.

Intuitive User Interface

MindFlow's shortcuts are seamlessly integrated into the user interface, ensuring a user-friendly and intuitive platform that caters to both novice and experienced writers. The focus is on enhancing your writing experience and helping you express your thoughts effortlessly.

Dependencies

MindFlow is built with several key dependencies, including:

  • next for a robust and efficient front-end development environment.

  • react and react-dom for building interactive user interfaces.

  • tailwindcss for flexible and customizable styling.

  • shadcn UI library.

  • next-themes for seamless theming and light/dark mode switching.

  • react-hotkeys-hook for handling keyboard shortcuts.

Contribute

We welcome contributions from the open-source community to make MindFlow even better. Whether it's adding new features, fixing bugs, or improving documentation, your contributions are highly appreciated.

Getting Started

To get started with MindFlow, follow these simple steps:

  1. Clone the repository to your local machine.

  2. Install the required dependencies using npm or yarn.

  3. Run the development server using npm run dev or yarn dev.

  4. Explore the features and shortcuts to unleash your creativity.

License

This project is licensed under the MIT License. Feel free to use and modify it for your purposes.

Explore the world of expressive writing and clear your mind with MindFlow. Start your creative journey today!