LocalGrammerly

An offline grammar assistant based on Google Chrome Built-in AI or Google Gemini Nano, designed to help you write better anytime, anywhere

LocalGrammerly is a lightweight grammar assistant that works completely offline, based by Google Chrome Built-in AI and Google Gemini Nano. It helps you write better by correcting grammar, summarizing text, and providing writing prompts—all while keeping your data private.

---

DEMO : https://vimeo.com/1035397079

---

🚀 Features

1. Offline Grammar Correction (WIP):
   Detects grammar mistakes and suggests corrections without needing an internet connection.

2. SummarizeOnHighlight:
   Highlight any text, and it gives you a quick summary—perfect for reading long articles or research papers.

3. Local Prompt AI:
   A simple UI to interact with a locally running AI, providing writing prompts and suggestions without relying on external servers.

4. Planned Features:

   • Autocomplete: Suggests words while you type to save time.
   • WritingDaemon: Provides tips to improve your writing style.

---

🛠️ Tech Stack

Frontend

• HTML: Structure of the interface
• CSS: Styling and layout
• JavaScript: Handling user interactions

Backend

• JavaScript: Core logic, grammar correction, and summarization
• • Chrome Extension: Runs seamlessly inside the browser
• • Google Chrome Built-in AI APIs: Powers of built-in AI features

---

🚀 Installation

1. Clone the Repository

git clone https://github.com/junaidcodingmaster/LocalGrammarly.git
cd LocalGrammarly

2. Load as a Chrome Extension

1. Open Google Chrome and go to chrome://extensions/.
2. Enable Developer Mode (top right).
3. Click Load Unpacked and select the LocalGrammarly folder.
4. LocalGrammerly is now ready to use in your browser! 🎉

---

📚 Usage

• To Summarize Text:

  1. Highlight the text you want to summarize.
  2. Right-click and select "Summarize with LocalGrammerly."

• To Access PromptAI:

  1. Click the extension icon.
  2. Select "Get Writing Prompt."

---

🌟 Challenges

1. Joined Late:
   I started this project late in November because I was busy with my pre-final exams.

2. Balancing Exams & Development:
   It was tough to manage both, and I had to pause development on December 2nd, 2024.

3. Incomplete Features:
   Some planned features like Autocomplete and WritingDaemon couldn’t be finished before the deadline.

---

🏆 Accomplishments

• Created a working offline grammar checker in a short time.
• Successfully implemented SummarizeOnHighlight, a handy tool for quick text summaries.
• Managed to balance hackathon participation with exam preparation.

---

🔮 What's Next?

Once my exams are done, I plan to:

• Complete Grammar Correction for better accuracy.
• Add Autocomplete to improve typing speed.
• Finish WritingDaemon to offer personalized writing tips.
• Optimize the tool for better performance and user experience.

---

🤝 Contributing

LocalGrammerly is open-source! Feel free to contribute, report issues, or suggest features.

1. Fork the repo.
2. Create a new branch (git checkout -b feature-name).
3. Commit your changes (git commit -m 'Add feature').
4. Push to the branch (git push origin feature-name).
5. Open a pull request.

---

📄 License

This project is licensed under the MIT License—free to use, modify, and share! License

---

💬 Connect with Me

If you have any questions or suggestions, feel free to reach out!

• Email: junaid@abujuni.dev
• Portfolio: abujuni.dev

---

This is my 1st hackathon project.