https://github.com/tabbyml/quick-question

https://github.com/tabbyml/quick-question

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tabbyml/quick-question
• Owner: TabbyML
• License: apache-2.0
• Created: 2023-03-11T04:29:39.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-08T15:08:23.000Z (about 3 years ago)
• Last Synced: 2025-09-19T02:45:56.372Z (9 months ago)
• Language: TypeScript
• Homepage:
• Size: 2.44 MB
• Stars: 14
• Watchers: 2
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## ⁉️ QuickQuestion

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

![Docker build status](https://img.shields.io/github/actions/workflow/status/TabbyML/quick-question/docker.yml?label=docker%20image%20build)

## 🤔 What is this?

An incubating AI-powered Q&A for your codebase.

[Live Demo](https://quick-question.fly.dev)

![Example Quick Question](example-quick-question.png)

## 🚀 Deployment

Make sure [git-lfs](https://git-lfs.com/) is installed.

1. Clone the repository.

    ```bash

    git clone https://github.com/TabbyML/quick-question.git

    ```

2. Save your OPENAI_API_KEY to file as secret.

    ```bash

    echo YOUR_OPENAI_API_KEY > openai_api_key.txt

    ```

3. **Optional** Run Quick Question on your github project.

   1. Create new directory for you project under `/data`, e.g `/data/quick-question`.

   2. Add a new `metadata.json` file in your project directory.

   Here is a templete of file content, replace `{GITHUB_PROJECT}` with your own project name, e.g `TabbyML/quick-question`.  

        ```json

        {

            "name": "{GITHUB_PROJECT}",

            "exampleQueries": ["How to ...?"]

        }

        ```

        > See [./data/diffusers/metadata.json](./data/diffusers/metadata.json) for a complete example.

4. Start container.

    ```

    docker-compose up

    ```

## 🛠️ Development

1. Make sure [git-lfs](https://git-lfs.com/) is installed.

2. Clone the repository, runs `yarn` to install dependencies.

3. Run `yarn lerna run build`.

4. Switch workdir to `./packages/quick-question`.

3. Copy `.env.sample` to `.env.local`, and set your `OPENAI_API_KEY`.

4. Run `yarn dev` to start local development 

## ❤️ Acknowledgement

Many thanks to WizAI for contributing with [code-search](https://github.com/wizi-ai/code-search), a project that QuickQuestion branched from.