Skip to content

mariomka/flow-pal

Repository files navigation

FlowPal

FlowPal is a writing enhancement tool designed to assist users in improving their text by maintaining the intended style while correcting errors. It leverages the capabilities of Vue.js and an LLM to provide a user-friendly interface for text processing and style-specific improvements.

Live Demo

Try FlowPal online at: https://mariomka.github.io/flow-pal/

Personal Note

This project, FlowPal, represents a significant milestone as it is the first project created entirely by AI without any manual code modifications. It marks a new chapter in my journey, providing invaluable assistance in enhancing my English writing skills. I am excited to see how this tool will continue to support my growth and development.

Features

  • Multiple Writing Styles

    • Preserve Original Style - Maintains your writing style while fixing errors
    • Business - Professional and clear tone for business communication
    • Technical - Precise and detailed tone for technical documentation
    • Casual - Friendly and conversational tone
    • Marketing - Engaging and persuasive tone for promotional content
    • Simple - Clear and easy-to-understand language for general audiences
  • Smart Text Processing

    • Grammar and spelling correction
    • Style-specific improvements
    • Spanish text handling and translation
    • Custom instruction support
    • Visual diff view to track changes
  • User-Friendly Interface

    • Clean, modern design
    • Efficient text processing
    • Copy and paste functionality
    • Easy text comparison
    • Persistent settings

Getting Started

Prerequisites

  • Node.js
  • npm
  • OpenAI API key

Installation

  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Access the application in your browser and click the settings icon in the top-right corner to enter your OpenAI API key.

About

FlowPal enhances writing clarity and style, offering multiple styles and efficient processing.

Resources

License

Stars

Watchers

Forks