{"id":22050113,"url":"https://github.com/oconva/qvikchat-starter-template","last_synced_at":"2026-04-10T01:10:13.983Z","repository":{"id":247306733,"uuid":"825127000","full_name":"oconva/qvikchat-starter-template","owner":"oconva","description":"Pre-configured project to get started with QvikChat quickly.","archived":false,"fork":false,"pushed_at":"2024-11-18T13:40:22.000Z","size":1245,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-28T21:17:50.071Z","etag":null,"topics":["ai","chat-service","chatbot","conversational-ai","genkit","langchain","qvikchat"],"latest_commit_sha":null,"homepage":"https://qvikchat.pkural.ca","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oconva.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-06T21:24:23.000Z","updated_at":"2024-08-13T20:44:23.000Z","dependencies_parsed_at":"2024-07-13T07:24:01.364Z","dependency_job_id":"e016ab56-1780-4658-982c-14627b3308bf","html_url":"https://github.com/oconva/qvikchat-starter-template","commit_stats":null,"previous_names":["oconva/qvikchat-starter-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oconva%2Fqvikchat-starter-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oconva%2Fqvikchat-starter-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oconva%2Fqvikchat-starter-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oconva%2Fqvikchat-starter-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oconva","download_url":"https://codeload.github.com/oconva/qvikchat-starter-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245119592,"owners_count":20563763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","chat-service","chatbot","conversational-ai","genkit","langchain","qvikchat"],"created_at":"2024-11-30T14:17:55.927Z","updated_at":"2025-12-30T23:32:12.727Z","avatar_url":"https://github.com/oconva.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QvikChat Starter Template\n\nThis is a starter template for QvikChat. It comes pre-configured with the following features:\n\n- **QvikChat**: QvikChat installed and configured to start serving chat endpoints.\n- **TypeScript**: TypeScript to allow you to write type-safe code efficiently.\n- **ESLint**: ESLint to enforce code quality and consistency.\n- **Prettier**: Prettier to format your code automatically and ensure consistent code style.\n- **Jest**: Jest to run your tests and ensure your code works as expected.\n- **GitHub Actions**: GitHub Actions to run your tests and lint your code automatically on every push.\n- **SWC**: For faster and more efficient TypeScript compilation.\n- **PNPM**: PNPM to manage your dependencies efficiently.\n\n## Getting Started\n\nSimply, clone the [QvikChat starter template](https://github.com/oconva/qvikchat-starter-template) to get started.\n\n```bash copy\ngit clone https://github.com/oconva/qvikchat-starter-template.git\n```\n\n### Setup Environment Variables\n\nCreate a `.env` file in the root of the project and add the following environment variables:\n\n```env copy\nGOOGLE_GENAI_API_KEY=\nOPENAI_API_KEY=\nGOOGLE_APPLICATION_CREDENTIALS=\n```\n\nAlternatively, you can copy the `.env.tmp` file or rename it to `.env` and fill in the values.\n\nBy default QvikChat uses the Google GenAI, so to use QvikChat with default settings, you need to provide the `GOOGLE_GENAI_API_KEY`. You don't have to set values for other environment variables if you are using the default settings.\n\nAdd value to the `OPENAI_API_KEY` variable if you're going to use OpenAI models and to the `GOOGLE_APPLICATION_CREDENTIALS` variable if you're going to use Firebase Firestore.\n\n### Running the Project\n\nYou can run the following commands to get started:\n\n```bash copy\nnpm install # or pnpm install\nnpm run dev # or pnpm dev\n```\n\nThe starter template predefines some chat endpoints. Once, you run the project, you can test the endpoints from terminal using command below:\n\n```bash copy\ncurl -X POST \"http://127.0.0.1:3400/chat\" -H \"Content-Type: application/json\"  -d '{\"data\": { \"query\": \"Answer in one sentence: What is Firebase Firestore?\" } }'\n```\n\nAbove example points to `http://127.0.0.1:3400`. You can change this port and host depending on where you are running the server and on which port.\n\nYou could also use the [Genkit Developer UI](#genkit-developer-ui) to test the endpoints.\n\n### Testing\n\nThe starter template comes with Jest pre-configured to run your tests, and some tests predefined in the `src/tests` directory. You can run the tests using the following command:\n\n```bash copy\nnpm run test # or pnpm test\n```\n\nPlease ensure you have the environment variables set up before running the tests.\n\nBy default, Jest is configured to test the source code in the `src` directory. You can change the configuration in the `jest.config.js` file, along with any other Jest configurations you may want to change.\n\n### Genkit Developer UI\n\nYou can run the Genkit developer UI to test the endpoints. Testing the endpoints using a graphical interface is probably the easiest way to get started. You can know more about the Genkit Developer UI [here](https://firebase.google.com/docs/genkit/devtools#genkit_developer_ui).\n\nStart the Genkit developer UI:\n\n```bash copy\nnpx genkit start\n```\n\nOR, you can install the Genkit CLI globally:\n\n```bash copy\nnpm i -g genkit\n```\n\nThen start the Genkit developer UI:\n\n```bash copy\ngenkit start\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foconva%2Fqvikchat-starter-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foconva%2Fqvikchat-starter-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foconva%2Fqvikchat-starter-template/lists"}