README.md

Leetcode Helper Bot

A browser extension designed to assist users in solving LeetCode problems by providing real-time information and tools.
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is a browser extension designed to assist users in solving LeetCode problems by providing real-time information and tools.

Features

• Real-time Problem Information: Fetch and display problem details directly from LeetCode.
• Chat Interface: Interact with the bot to get hints and guidance on solving problems.
• Syntax Highlighting: View code snippets with syntax highlighting for better readability.
• Chat History: Maintain a history of your interactions with the bot.
• Dark Mode Support: Automatically switch between light and dark themes based on user preference.
• User-Friendly Interface: Easy-to-use interface for seamless interaction.

Built With

• React - A JavaScript library for building user interfaces.
• TypeScript - A typed superset of JavaScript that compiles to plain JavaScript.
• Framer Motion - A library for animations in React.
• React Syntax Highlighter - A library for syntax highlighting in code snippets.
• Chrome Extensions API - For building the browser extension.

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

• Node.js (v14 or later)
• npm (Node Package Manager)

Installation

1. Clone the repo

   git clone https://github.com/sahilverma-dev/leetcode-helper-extension

2. Navigate to the project directory

   cd leetcode-helper-extension

3. Install the required packages

   npm install

4. Build the project

   npm run build

5. Load the extension in your browser:
   • Open Chrome and go to chrome://extensions/
   • Enable "Developer mode"
   • Click "Load unpacked" and select the build directory of your project.

Usage

1. Open the LeetCode website and navigate to a problem.
2. Click on the LeetCode Helper Bot extension icon in your browser.
3. Interact with the bot to get hints and guidance on solving the problem.
4. Use the chat interface to maintain a history of your interactions.

Roadmap

• Add more features for enhanced user experience.
• Improve the chat interface with more interactive elements.
• Implement user authentication for personalized experiences.
• Expand support for additional coding platforms.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact Me

• Email: [email protected]
• Portfolio: sahilverma.dev
• GitHub: @sahilverma-dev
• Twitter: @sahilverma_dev
• LinkedIn: sahilverma-dev

Acknowledgments

• Gemini for providing the AI model.
• LeetCode for the coding challenges.
• React Community for their support and resources.

(back to top)