Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imankulov/refiner
Refiner improves your writing by correcting grammar and style, adjusting tone, and offering formatting options. It is useful for non-native speakers and professionals who communicate with text.
https://github.com/imankulov/refiner
chatgpt chatgpt-app gpt gpt-3 nextjs openai text-processing webapp
Last synced: about 2 months ago
JSON representation
Refiner improves your writing by correcting grammar and style, adjusting tone, and offering formatting options. It is useful for non-native speakers and professionals who communicate with text.
- Host: GitHub
- URL: https://github.com/imankulov/refiner
- Owner: imankulov
- License: mit
- Created: 2023-06-15T14:37:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-20T19:13:25.000Z (7 months ago)
- Last Synced: 2024-10-12T07:32:52.240Z (3 months ago)
- Topics: chatgpt, chatgpt-app, gpt, gpt-3, nextjs, openai, text-processing, webapp
- Language: TypeScript
- Homepage: https://refiner.roman.pt
- Size: 1.21 MB
- Stars: 41
- Watchers: 3
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Refiner
## Introduction
Refiner is an open source online app designed to improve your written communication. By automatically correcting grammar and stylistic errors, adjusting the tone, and providing various formatting options (e.g., markdown or bullet point conversion), Refiner ensures your messages are clear and accurate. This tool is particularly valuable for non-native speakers and remote working professionals aiming to enhance their written communication.
## Features
1. **Grammar and Style Refinement**: Corrects grammatical and stylistic errors.
2. **Tone Adjustment**: Adjusts the tone of the text as needed.
3. **Text Formatting**: Includes markdown formatting and bullet point conversion.
4. **Non-Native Speaker Friendly**: Specially designed to support non-native English speakers in improving their written communication.
## Requirements
1. Node.js v14.0.0 or above
2. An account at OpenAI
3. Docker (optional)
## Installation
Clone the repository:
```bash
git clone https://github.com/imankulov/refiner.git
cd refiner
```
Install the required packages:
```bash
npm install
```
Copy and modify the env file:
```bash
cp env.example .env.local
edit .env.local
```
You will need an OpenAI API key. Create one at https://platform.openai.com/account/api-keys.
(Optional) To run with Docker:
```bash
make build
make run
```
## Usage
Start the server:
```bash
npm run dev
```
Navigate to `localhost:3000` in your browser.
Enter the text you want to refine into the provided field, select your desired settings, and then click 'Refine'. The service will do the rest.
## Licenses
Refiner is an open-source product licensed under MIT. See the LICENSE file for more details.