https://github.com/oconva/qvikchat-docs

Documentation for QvikChat
https://github.com/oconva/qvikchat-docs

chat-service chatbot conversational-ai genkit langchain qvikchat rag

Last synced: about 1 month ago
JSON representation

Documentation for QvikChat

• Host: GitHub
• URL: https://github.com/oconva/qvikchat-docs
• Owner: oconva
• License: mit
• Created: 2024-07-07T04:32:51.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-05T02:09:31.000Z (5 months ago)
• Last Synced: 2024-11-24T20:40:02.219Z (about 1 month ago)
• Topics: chat-service, chatbot, conversational-ai, genkit, langchain, qvikchat, rag
• Language: MDX
• Homepage: https://qvikchat.pkural.ca
• Size: 2.45 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# QvikChat Docs

QvikChat Docs is the documentation website for [QvikChat](https://github.com/oconva/qvikchat) framework.

**QvikChat** is a [Firebase Genkit](https://github.com/firebase/genkit) and [LangChain](https://js.langchain.com/v0.2/docs/introduction/) based framework that provides you with a solid foundation to build powerful AI-powered chat service endpoints quickly and efficiently. It includes support for **multiple types of conversations (open-ended, close-ended)**, **chat history**, **response caching**, **authentication**, and **information retrieval using Retrieval Augmented Generation (RAG).**

[Get Started](https://qvikchat.pkural.ca/getting-started) | [Documentation](https://qvikchat.pkural.ca)

## Documentation Website Local Development

First, run `pnpm i` to install the dependencies.

Then, run `pnpm dev` to start the development server and visit localhost:3000.

## Contributions

Contributions are welcome! Please refer to the [contribution guidelines](CONTRIBUTING.md) for more information.

## Issues

If you encounter any issues or bugs while using the starter kit, please report them by following these steps:

1. Check if the issue has already been reported by searching our issue tracker.

2. If the issue hasn't been reported, create a new issue and provide a detailed description of the problem.

3. Include steps to reproduce the issue and any relevant error messages or screenshots.

[Open Issue](https://github.com/oconva/qvikchat-docs/issues)

## License

This project is licensed under the MIT License.

## Credits

This documentation website was created using [Nextra](https://github.com/shuding/nextra) site generation framework.

## Oconva

QvikChat is a project by [Oconva](https://github.com/oconva). Oconva is an initiative to make conversational AI more open and accessible to all. Oconva's vision is to create a future where any developer, regardless of their available resources, can empower their apps with the power of conversational AI. Whether it's adding an AI assistant to their app or integrating a translation service, Oconva aims to provide developers with open-source tools and frameworks to support them on this journey.