A React component library for grammar checking and rectification
npm install grammar-checker-libsA React component library for grammar checking and rectification with real-time suggestions and corrections.
- Real-time grammar checking
- Intelligent error detection and suggestions
- Fast and reliable grammar corrections
- Free and open-source
- Easy integration with existing React applications
``bash`
npm install grammar-checker-libs
or
`bash`
yarn add grammar-checker-libs
`bash
#for npm
npm install grammar-checker-libs
#for yarn
yarn add grammar-checker-libs
`
This library requires a backend server to process grammar checks. Download and setup the server:
Clone the backend repository:
`bash`
git clone https://github.com/Ajay7616/grammar-check-backend.git
cd grammar-check-backend
Start the Java LanguageTool Server (Port 8081):
`bash`
java -cp "LanguageTool-6.3/languagetool-server.jar" org.languagetool.server.HTTPServer --port 8081
Start the Python Server:
`bash`
pip install -r requirements.txt
python app.py
> Note: Run the Java server first, then the Python server. Both must be running for the grammar checker to work.
`javascript
import { GrammarRectifier } from 'grammar-checker-libs';
function MyComponent() {
return (
);
}
`
`javascript
import { GrammarRectifier } from 'grammar-checker-libs';
function MyComponent() {
return (
);
}
`
`javascript
import { GrammarRectifier } from 'grammar-checker-libs';
import * as api from 'grammar-checker-libs';
async function checkGrammar(text) {
try {
const result = await api.checkGrammar(text);
console.log(result);
} catch (error) {
console.error('Grammar check failed:', error);
}
}
`
If you're using Create React App and encounter module resolution errors with http, https, stream, etc., you need to configure webpack polyfills:
1. Install required packages:
`bash`
npm install --save-dev react-app-rewired node-polyfill-webpack-plugin stream-http https-browserify url assert stream-browserify util browserify-zlib
2. Create config-overrides.js in your project root:
`javascript
const NodePolyfillPlugin = require('node-polyfill-webpack-plugin');
module.exports = function override(config) {
config.resolve.fallback = {
...config.resolve.fallback,
http: require.resolve('stream-http'),
https: require.resolve('https-browserify'),
url: require.resolve('url'),
assert: require.resolve('assert'),
stream: require.resolve('stream-browserify'),
util: require.resolve('util'),
zlib: require.resolve('browserify-zlib'),
};
config.plugins.push(new NodePolyfillPlugin());
return config;
};
`
3. Update your package.json scripts:
`json`
{
"scripts": {
"start": "react-app-rewired start",
"build": "react-app-rewired build",
"test": "react-app-rewired test"
}
}
Note: This is only required for Create React App with Webpack 5. Modern tools like Vite, Next.js, or newer React frameworks handle this automatically.
####
The main component for grammar checking and correction.
Important: This component only works with and