Skip to content

Latest commit

 

History

History
94 lines (69 loc) · 2.91 KB

README.md

File metadata and controls

94 lines (69 loc) · 2.91 KB
Raw

CheatCode

Welcome to CheatCode! This application allows users to solve LeetCode-style problems and receive personalized feedback and hints for their solutions, powered by generative AI. The app is built using Next.js, Vercel AI SDK, and Llama 3.1.

Table of Contents

Features

  • Sign Up and Login: Users can create an account and log in to access personalized features.
  • Random Question Selection: Select a random question from a dropdown menu.
  • Solve and Submit Solutions: Submit solutions to the questions and receive test case validation.
  • Personalized Feedback: Get detailed feedback on your solutions, including suggestions for improvements and optimization.
  • Hints and Optimization Suggestions: Receive hints and optimization suggestions generated by Llama 3.1 AI to improve your problem-solving skills.

Technologies Used

  • Next.js: Frontend and backend framework.
  • Vercel AI SDK: Integration for AI features.
  • Llama 3.1: Generative AI model used for feedback and hints.

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/leetcode-solver-web-app.git
cd leetcode-solver-web-app

  2. Install dependencies:

    npm install

  3. Set up environment variables: Create a .env.local file and add the necessary environment variables for your setup.

    NEXT_PUBLIC_API_KEY=your-vercel-ai-sdk-api-key
NEXT_PUBLIC_LLAMA_MODEL_VERSION=3.1

  4. Run the development server:

    npm run dev

  5. Open your browser and navigate to:

    http://localhost:3000

Usage

  1. Sign Up/Login: Create an account or log in with your credentials.
  2. Search for Questions: Use the search functionality to find questions by category.
  3. Select a Question: Choose a random question or select one based on difficulty.
  4. Submit Your Solution: Write and submit your code for the selected question.
  5. Receive Feedback: View personalized feedback, hints, and optimization suggestions generated by Llama 3.1.

Contributing

We welcome contributions to improve this project! To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them: 
    git commit -m 'Add your feature description'
  4. Push to the branch: 
    git push origin feature/your-feature-name
  5. Open a pull request and describe your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Feel free to reach out if you have any questions or need further assistance. Happy coding!