https://github.com/nermalcat69/niter

An ai 🤖 based tool to fix your silly grammar mistakes ✨
https://github.com/nermalcat69/niter

ai grammar nermalcat69 niter

Last synced: about 4 hours ago
JSON representation

An ai 🤖 based tool to fix your silly grammar mistakes ✨

• Host: GitHub
• URL: https://github.com/nermalcat69/niter
• Owner: nermalcat69
• License: mit
• Created: 2023-11-25T08:15:35.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-01-16T18:06:49.000Z (10 months ago)
• Last Synced: 2024-01-17T02:50:54.490Z (10 months ago)
• Topics: ai, grammar, nermalcat69, niter
• Language: TypeScript
• Homepage: https://niter.vercel.app
• Size: 2.2 MB
• Stars: 17
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Niter - [Preview](https://niter.vercel.app)

Crafting well-written English, free from grammar and punctuation errors, can be challenging for many individuals. Transform your writing experience with Niter! Explore its capabilities [here](https://niter.vercel.app) and elevate the quality of your content.



## Table of Contents

- [Introduction](#introduction)

- [Features](#features)

- [Usage](#usage)

- [Tech Stack](#tech-stack)

- [Installation Guide](#installation-guide)

- [Contribution](#contribution)

- [License](#license)

## Introduction

Welcome to **Niter**, your go-to tool for enhancing the quality of your written content effortlessly. Are you struggling with perfecting your English, tackling grammar issues, or mastering punctuation? Look no further – Niter is here to streamline your writing process.

## Features

1. Smart Grammar Correction:

> Niter employs advanced algorithms to intelligently correct grammar, ensuring your writing is polished and error-free.

2. Instant Punctuation Perfection:

> With Niter's powerful capabilities, enjoy the convenience of immediate and accurate punctuation corrections, making your writing stand out effortlessly.

## Usage

1. Navigate to the [homepage](https://niter.vercel.app) to access Niter.

2. Click on the engaging [playground](https://niter.vercel.app/playground) feature.

3. Simply paste your article into the chat section, and witness the magic unfold as Niter provides you with a preview of your article, impeccably corrected for punctuation and grammar.

## Installation Guide

1. Clone the repository: `git clone https://github.com/nermalcat69/niter.git`

2. Install project dependencies by `npm install`

3. Create `.env` file and add your API key:

   ```bash

   OPENAI_API_KEY=your key here

   ```

4. Run the server by `npm run dev`

## Tech Stack

1. Next.js: A React framework facilitating server-side rendering and client-side navigation.

2. Tailwind CSS: A utility-first CSS framework for rapid and responsive UI development.

3. React Hooks: Leveraging functional components for efficient state and side effect management.

4. OpenAI Edge: Harnessing OpenAI for advanced language processing and natural language understanding.

### Contribution

You're free to do a pull request here and dont forget to check the issues:D

## License

This project is licensed under the [MIT License](LICENSE).