Waner Proofreader

Waner Proofreader is an AI-powered tool designed to help non-native English speakers proofread their text smoothly.

The tool is named after the character Shangguan from the game Honor of Kings (王者荣耀里的上官婉儿) the historical figure Shangguan Wan'er (上官婉儿), a renowned Chinese poet and politician.

Here is a demo. You need to configure your own API URL and key to use it.

Screenshots

Installation

To run Waner Proofreader locally, ensure that you have Node.js installed on your machine. Follow these steps to set up the project:

1. Clone the repository:

   git clone https://github.com/AuroraDysis/waner-proofreader.git

2. Navigate to the project directory:

   cd waner-proofreader

3. Install the required dependencies:

   npm install

4. Create a .env file in the root directory and add the following environment variables:

   CONFIG=<base64 encoded TOML>
   NEXT_PUBLIC_OPENAI_MODEL=anthropic/claude-3.5-sonnet,anthropic/claude-3-opus,openai/chatgpt-4o-latest,openai/gpt-4,google/gemini-2.0-flash-thinking-exp:free
   

   where <base64 encoded TOML> is the base64 encoded TOML configuration file. The TOML file should contain the following information:

   [[users]]
   name = "name"
   key = "password"
   openai_base_url = "base url of API endpoint, for example, https://openrouter.ai/api/v1 or https://api.openai.com/v1"
   openai_api_key = "your api key of the endpoint"
   
   [[users]]
   name = "another name"
   ...

   If you want to use providers other than OpenRouter, you may need to modify NEXT_PUBLIC_OPENAI_MODEL accordingly. Alternatively, you can set the model in the UI. Replace <your_api_key> with your API key for security. You can pass multiple keys separated by commas.

5. Start the development server:

   npm run dev

6. Open your web browser and visit http://localhost:3000 to access Waner Proofreader.

Credits

• Some parts of the code & prompts are inspired by refiner
• Some prompts are inspired by editGPT
• Some prompts are inspired by GenAI LaTeX Proofreader

Licenses

waner-proofreader is licensed under the MIT License. See LICENSE for more information.