Git Product home page Git Product logo

quick-question's Introduction

⁉️ QuickQuestion

License Docker build status

🤔 What is this?

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

Live Demo

Example Quick Question

🚀 Deployment

Make sure git-lfs is installed.

  1. Clone the repository.

    git clone https://github.com/TabbyML/quick-question.git
  2. Save your OPENAI_API_KEY to file as secret.

    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.

      {
          "name": "{GITHUB_PROJECT}",
          "exampleQueries": ["How to ...?"]
      }

      See ./data/diffusers/metadata.json for a complete example.

  4. Start container.

    docker-compose up
    

🛠️ Development

  1. Make sure git-lfs is installed.
  2. Clone the repository, runs yarn to install dependencies.
  3. Run yarn lerna run build.
  4. Switch workdir to ./packages/quick-question.
  5. Copy .env.sample to .env.local, and set your OPENAI_API_KEY.
  6. Run yarn dev to start local development server.

🙋 We're hiring

Come help us make Tabby even better. We're growing fast and would love for you to join us.

❤️ Acknowledgement

Many thanks to WizAI for contributing with code-search, a project that QuickQuestion branched from.

quick-question's People

Contributors

wsxiaoys avatar zalkar-z avatar icycodes avatar beedward avatar myin8 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.