Join FlowChai Now

Create Free Account

A Guide to Using FlowChai AI to Use Code from a GitHub Repo

FlowChai is a platform designed to help you understand and work with code repositories, among other types of data. This guide provides a step-by-step walkthrough of how to use FlowChai to interact with a GitHub repository by downloading its zip file, creating a new project in FlowChai, and asking questions about the repo.


Download Zip File from GitHub Repository

  1. Open GitHub Repository: Navigate to the GitHub repository you are interested in using.
  2. Download Zip:
    • Click on the Code button, usually located near the top-right corner of the repository page.
    • From the dropdown, click Download ZIP.
    • Save the ZIP file to a location you can easily access.

In FlowChai

Create a New Project

  1. Login to FlowChai: Navigate to the FlowChai website and log in to your account.
  2. Navigate to Projects: Go to the "Projects" section.
  3. Create New Project: Click the New Project button.
  4. Enter Project Details:
    • Provide a name for your project.
  5. Save and Continue: Click on the Add Project button to create the project.

Upload Zip File

  1. Navigate to Upload Section: In your new project, find the section where you can upload files, under the "Upload Data" dropdown.
  2. Upload Zip File:
    • Click the Upload button.
    • Browse your filesystem to locate the ZIP file you downloaded from GitHub.
    • Select the ZIP file and click Upload Files to upload it to FlowChai.

Create a Report

  1. Navigate to Report Section: After uploading, click on the "Generate Report" button next to the upload notification

  2. Enter a prompt, then click "Generate Report". Here are some prompt ideas:

  3. Overview: "Can you give me an overview of this repository?"

  4. Dependencies: "What dependencies does this repository have?"

  5. File Structure: "Describe the file structure of this repository."

  6. Contributors: "Who are the main contributors to this repository?"

  7. Code Usage: "How do I use this code?"

  8. Writing Code: "Can you show me an example code snippet to get started with this repository?"


By following this guide, you should be able to successfully use FlowChai to interact with a GitHub repository, helping you understand its structure, dependencies, contributors, and more. This enables you to make informed decisions and write code more efficiently.

Related Guides

Join FlowChai Now

Create Free Account