Giter Club home page Giter Club logo

ai-text-editor's Introduction

ai-text-editor

AI-powered text editor designed to streamline your writing workflow. Manage documents, collaborate seamlessly with AI models, and utilize powerful macros for unmatched productivity.


Visit Website · Report Bugs · Request Feature

Key Features:

  • Document Management System: Easily create, edit, organize and export your writings.
  • AI Integration: Direct interaction with AI model providers, enhancing your writing with suggestions, edits, and creative ideas.
  • Privacy First: Your documents and API key are stored locally on your device, ensuring your data remains yours.
  • Instant Macros & Selection Sending: Improve your workflow with customizable prompts and the ability to query the AI about specific text selections.
  • Mobile & Desktop Accessibility: Designed for compatibility across both desktop and mobile operating systems

Prerequisites

Ensure that you have the following prerequisites installed and set up on your system:

  1. Node.js: The application is built using Node.js, so you need to have it installed on your machine. You can download the latest version of Node.js from the official website.

  2. OpenAI API Key: The application requires an OpenAI API key for AI integration. Sign up for an OpenAI account and obtain an API key from the OpenAI Developer Dashboard.

Getting Started

To begin using ai-text-editor, you can visit our website to access or setup your own instance by following the steps below:

  1. Clone the repository:
git clone https://github.com/darrylschaefer/ai-text-editor
  1. Change directory:
cd ai-text-editor
  1. Install dependencies:
npm install
  1. Run the dev server:
npm run dev
  1. Open your browser: Navigate to http://localhost:5173 to start working with ai-text-editor on your local machine.

Support and Contributions

We welcome contributions and feedback to make ai-text-editor even better. Whether it's feature requests, bug reports, or code contributions, please feel free to reach out or open an issue in our repository.

Privacy and Security

All data, including documents and your API key, remain stored locally on your browser. No third-party access to your documents unless you choose to interact with external APIs (such as the OpenAI Chat API), which is done under your control with your API key.

Mobile/Desktop Version

ai-text-editor supports both mobile and desktop access, ensuring you can continue your work seamlessly across devices. For the best experience, it's recommended to use the latest version of Chrome.

Backup and Data Management

It's crucial to regularly export your data for backups. Through the sidebar's 'export' feature, you can save your documents and chats securely and import them back at any time.

Frequently Asked Questions (FAQs)

Q: How is our data stored, and who has access?

A: Your documents are stored locally on your device via IndexedDB. If you use the OpenAI API or any custom API, you might send document and selection data to their servers during the request process.

Q: How do I back up my data?

A: You can routinely back up your data by using the 'export' feature in the sidebar. This action will generate a .JSON file of your documents and chats.

Q: Do I need to pay OpenAI?

A: Yes, using your own API key means you'll interface directly with the OpenAI servers, so it's recommended to set limits and monitor spending in your OpenAI dashboard. If you use an alternative API, you may need to pay to the provider of this API.

For more detailed information, please refer to our FAQ section.

Special Thanks

This project was inspired by and adapted from BetterChatGPT, originally released under the CC0 license. This modified version is released under the MIT license.

ai-text-editor's People

Contributors

darrylschaefer avatar

Stargazers

 avatar  avatar  avatar Asah Lesley avatar Catherine Oborski avatar Peilin Zhang avatar

Watchers

 avatar

Forkers

coborski

ai-text-editor's Issues

Import / export not importing

I changed some naming & it's broken a few of the persistence + import/export features.

Some notes:

  1. Old export files still import documents, which disappear after exiting & re-entering website
  2. New export files do not import documents at all

npm build fails with 'Error: Fallback bindings does not support this interface yet.'

System information:

$ uname -a
Linux zbox 6.5.7-artix1-1 #1 SMP PREEMPT_DYNAMIC Sun, 15 Oct 2023 22:13:26 +0000 x86_64 GNU/Linux

Node version:

$ npm --version
10.2.4

$ node --version
v21.2.0

Steps to replicate:

$ npm run build

> [email protected] build
> tsc && vite build

vite v4.1.4 building for production...
transforming (116) node_modules/match-sorter/dist/match-sorter.esm.jsBrowserslist: caniuse-lite is outdated. Please run:
  npx update-browserslist-db@latest
  Why you should do it regularly: https://github.com/browserslist/update-db#readme
✓ 1617 modules transformed.
rendering chunks (3)...[vite-plugin-top-level-await] Fallback bindings does not support this interface yet.
error during build:
Error: Fallback bindings does not support this interface yet.
    at Compiler.<anonymous> (/home/mortilla/stuff/fthr-text/node_modules/@swc/core/index.js:119:23)
    at Generator.next (<anonymous>)
    at /home/mortilla/stuff/fthr-text/node_modules/@swc/core/index.js:34:71
    at new Promise (<anonymous>)
    at __awaiter (/home/mortilla/stuff/fthr-text/node_modules/@swc/core/index.js:30:12)
    at Compiler.parse (/home/mortilla/stuff/fthr-text/node_modules/@swc/core/index.js:115:16)
    at Object.parse (/home/mortilla/stuff/fthr-text/node_modules/@swc/core/index.js:320:21)
    at /home/mortilla/stuff/fthr-text/node_modules/vite-plugin-top-level-await/dist/bundle-info.js:33:19
    at Array.map (<anonymous>)
    at parseBundleAsts (/home/mortilla/stuff/fthr-text/node_modules/vite-plugin-top-level-await/dist/bundle-info.js:31:78)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.