Skip to content

sharan-ravi/FlowWriter

Repository files navigation

FlowWriter

Welcome to FlowWriter, your on-device AI-powered writing assistant designed to enhance your writing experience by providing real-time text completions. With FlowWriter, staying in the creative flow is easier than ever, thanks to our privacy-first, local processing approach.

Features

  • On-Device AI: Leverages an on-device large language model to ensure your data privacy and security.
  • Real-Time Suggestions: Offers intelligent text completions as you type to keep your thoughts flowing without interruption.
  • Lightweight Design: Built with React and optimized with TypeScript for robust and scalable performance.
  • Stylish UI: Features a sleek, modern interface designed with TailwindCSS for a comfortable and engaging user experience.

Requirements

  • Latest version of Chrome
  • Minimum of 8GB of RAM for optimal performance

Getting Started

Prerequisites

Before you install FlowWriter, ensure you have Node.js installed on your machine. You can download it from nodejs.org.

Installation

  1. Clone the repository:
    git clone https://github.com/sharan-ravi/FlowWriter
  2. Navigate to the project directory:
    cd FlowWriter
  3. Install dependencies:
    npm install

Running the Application

To run FlowWriter on your local machine, execute the following command:

npm run dev

This will start the development server and open FlowWriter in your default web browser.

Contributing

Contributions to FlowWriter are always welcome! Whether it's bug fixes, feature enhancements, or improvements to documentation, please feel free to make a pull request.

License

FlowWriter is released under the MIT License.