Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 3.87 KB

README.md

File metadata and controls

65 lines (42 loc) · 3.87 KB

CatAI : LLM-Based AI Programming Support for Catrobat Applications

CatAI is an innovative project that integrates Large Language Models (LLMs) like GPT-4 into the Catrobat platform to provide powerful AI-driven programming support for users. With CatAI, you can expect a wide range of features and capabilities to make your Catrobat app development experience smoother, more efficient, and more enjoyable.

Project Overview

CatAI is designed to assist Catrobat app developers by leveraging advanced language models to offer the following types of support:

  • Code Generation: Automatically generate code from text prompts or descriptions, helping developers quickly implement desired features.
  • Error Correction: Identify and suggest fixes for common coding errors or issues, improving code quality and reducing debugging time.
  • Code Architecture Recommendations: Provide guidance on designing and structuring code, including suggesting optimal architectures and meaningful variable names.
  • Project Ideas: Generate creative project ideas based on your input and preferences.
  • Code Explanation: Provide detailed explanations for downloaded code snippets, helping you understand and modify code shared by others.

Getting Started

For help getting started with Flutter development, view the online documentation.

For instructions integrating Flutter modules to your existing applications, see the add-to-app documentation.

To get started with CatAI, follow these steps:

  • Clone the Repository: Begin by cloning this repository to your local development environment by running the following command in your terminal:
git clone https://github.com/your_username/catai-flutter.git

Installation:

  • Install Flutter
  • Get dependencies by running - flutter pub get
  • Add an API key for chatGPT in - lib/api_key.dart
  • Run app - flutter run lib/main.dart

Contributing

We welcome contributions from the community to enhance CatAI's capabilities and expand its support for Catrobat developers.

If you want to contribute we suggest that you start with forking the repository and browse the code. Then you can look at our Issue-Tracker and start with fixing one ticket. We strictly use Test-Driven Development and Clean Code, so first read everything you can about these development methods. Code developed in a different style will not be accepted. After you've created a pull request we will review your code and do a full testrun on your branch.

Also make sure to read our guidelines for creating a pull request

Issues

Please report all bugs on our Jira Bugtracker

Resources and links

License

CatAI is open-source software licensed under the GNU Affero General Public License. Please refer to the provided license for detailed terms and conditions.

Contact

If you have any questions, issues, or suggestions regarding CatAI, please don't hesitate to reach out to us.

Happy coding with CatAI! We hope this AI-powered tool enhances your Catrobat app development experience and makes it more productive and enjoyable.