Skip to content

4mJ0k3r/MiniCursor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MiniCursor - AI-Powered Code Assistant

MiniCursor is an AI-powered code assistant that helps developers create and manage React applications using natural language commands. It leverages OpenAI's GPT-4 model to understand user requirements and execute appropriate actions.

Features

  • 🤖 AI-powered code generation and project management
  • ⚛️ React project creation with Vite and TypeScript
  • 📦 Automatic dependency management
  • 🔧 Built-in tools for file operations and command execution
  • 🎨 Material UI integration for beautiful UIs
  • 🔄 Real-time project updates and modifications

Prerequisites

  • Python 3.8 or higher
  • Node.js 16 or higher
  • npm 7 or higher
  • OpenAI API key

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/minicursor.git
cd minicursor
  1. Install Python dependencies:
pip install -r requirements.txt
  1. Create a .env file in the project root and add your OpenAI API key:
OPENAI_API_KEY=your_api_key_here

Usage

  1. Start the application:
python app.py
  1. Interact with the AI assistant using natural language commands. For example:
> Create a React Todo app

The assistant will:

  • Create a new React project with TypeScript
  • Set up the project structure
  • Install necessary dependencies
  • Create required components
  • Provide instructions for running the app

Available Commands

  • Create React projects
  • Add components and features
  • Modify existing code
  • Run commands
  • Manage files and dependencies

Project Structure

minicursor/
├── app.py              # Main application file
├── requirements.txt    # Python dependencies
├── .env               # Environment variables (not tracked by git)
├── .gitignore         # Git ignore rules
└── README.md          # Project documentation

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

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

Acknowledgments

  • OpenAI for providing the GPT-4 API
  • React and Vite teams for the amazing tools
  • Material UI for the beautiful components

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages