Skip to content

Latest commit

 

History

History
156 lines (94 loc) · 6.16 KB

README.md

File metadata and controls

156 lines (94 loc) · 6.16 KB

FlutterGPT

VScode Downloads VScode version License: APACHE

Your Flutter AI Copilot powered with Gemini Code & Vision.


FlutterGPT is an open-source coding assistant specifically designed for Flutter Engineers. The assistant allows you to chat with Gemini inside VSCODE and create, refactor and debug code.

✨ Powered by Gemini
🤝 Dart Analyzer Inside
👨🏼‍💻 For and by Flutter Engineers

Our vision is to make Flutter development faster and easily adoptable by automating low-level workflows that we as developers work on a daily basis.


Getting Started

1. Create Free Gemini API Key

Visit Makersuite by Google and create your free API Key.

2. Add the key to FlutterGPT

In your VSCODE settings, search for fluttergpt.apiKey and paste the API Key.

3. Run your first command.

To get started, right-click on your editor in a dart project. Checkout all features below. 🔽

Features

🚀 Chat

Chat with Gemini inside VSCODE

Chat with Gemini Pro right from your IDE. Ask anything related to Flutter or Dart and get instant answers. Query your workspace using @workspace command.

💡 Create

Creating Widget using FlutterGPT

1. Widget from Image or Description

Use Gemini's multimodal capabilities to create widget from a image with added description.

Command: FlutterGPT Create: Widget from Image or Description

2. Complete Code from BluePrint

Get complete code from a blueprint of a class or function with the behaviour of functions, state management and architecture of your choice.

Command: FlutterGPT Create: Code from Blueprint

3. Complete Code from Description

Generate complete classes from your description.

Command: FlutterGPT Create: Code from Description

✨ Refactor

Refactoring Code using FlutterGPT

1. From Instruction

Refactor widgets and logic both with this command.

Command: FlutterGPT Refactor: From Instructions

2. Optimize Code

Pass your runtime errors and get fixed code back.

Command: FlutterGPT Refactor: Optimize

3. Auto Fix

Select any method or code with errors, run Auto Fix .

Command: FlutterGPT Refactor: Fix Errors

📝 Add to Reference

LLM's work great when provided with references along with the instructions. FlutterGPT users can now add any piece of code or customized descriptions as reference and they'll be passed to model for any command being used.

Practical usecases:

  1. Having widgets follow a state management and use a view model already defined in your code.

  2. Use snippets as a reference while refactoring large part of projects to use the same style and structure.

  3. In, codeFromBluePrint to generate full-fledged classes taking state management, architecture and style as reference from an existing class.

FAQs

  1. How safe and secure is it to use, and can you explain why?
  1. Do I need to pay to use FlutterGPT?
  • Gemini PRO is currently in early access and is completely free to use for upto 60 requests for minute. Please check the pricing here.
  1. I am an Android Studio user. Can I use FlutterGPT?

Contributing

FlutterGPT 💙 is community centric and any contribution is most welcome to make it useful for you!

Ways to contribute

  • Feature requests: Sugggest new features that'll make your development process easier. File at Issues Board.
  • Fix existing issues: Help us by fixing existing issues in our issues board.
  • Pick up approved features: You can also contribute by picking up approved features from our Roadmap.

To contribute, please follow the guidelines in our CONTRIBUTING.md file.

Community

We have friendly mentors and a supportive community ready to guide you every step of the way Join Now

Running Locally for Contribution

  1. Clone the repository.
  2. Run npm install
  3. Use the Run Extension command from launch.json for running the extension.
  4. Ensure you've specified the Gemini API key in the settings.

Roadmap

To get a sense of direction of where we're heading, please check out our Roadmap.

Known Issues

This is the beta version and can be unstable. Please check our issues board for any known issues.

Release Notes: 0.2.1

  • Major improvement in chat user experience.
  • Feature to provide workspace as context.
  • Minor bug fixes.

License

FlutterGPT is released under the Apache License Version 2.0. See the LICENSE file for more information.