Skip to content

README.md

Latest commit

 

History

History
75 lines (52 loc) · 1.79 KB

README.md

File metadata and controls

75 lines (52 loc) · 1.79 KB
Raw

🚀 LexiCorrect

A modern AI-powered web application for French spelling and grammar correction, combining a clean React-based frontend with a robust FastAPI backend powered by LanguageTool.

✨ Features

  • ✅ French spelling and grammar correction
  • 🔍 Detailed error detection (category, message, suggestions)
  • 📊 Text statistics (word count, error count)
  • 🎨 Modern glassmorphism UI
  • 🌐 REST API with FastAPI
  • ⚡ Real-time analysis

📝 Documentation

To run the project locally, follow the steps below:

  • Start by downloading the project from 👉 LexiCorrect GitHub repository or clone the repository using Git:

    git clone git@github.com:ranto-dev/LexiCorrect.git

  • Then, follow the installation instructions provided in 👉 Step-by-step guide

🛠️ Tech Stack

Frontend

  • HTML / CSS
  • JavaScript
  • React (via CDN)
  • Three.js
  • Fetch API

Backend

  • FastAPI (Python)
  • language_tool_python
  • LanguageTool 6.6
  • Java 17 (LanguageTool server)
  • Uvicorn

🧩 Future Improvements

  • 🌍 Multi-language support
  • 🖍️ Highlight errors directly in text
  • 📈 Advanced statistics (readability score)
  • 👤 User accounts & history
  • ☁️ Deployment with Docker

🤝 Contributing

Contributions are welcome!

  1. Fork the project
  2. Create your feature branch
  3. Commit your changes
  4. Open a Pull Request

📄 License

This project is licensed under the MIT License.

🙌 Acknowledgements