repo-chat sample project (#640)

Co-authored-by: Ben Perlmutter <[email protected]>

Author: mongodben

examples/repo-chat/.env.example

@@ -0,0 +1,9 @@
+# MongoDB config
+MONGODB_CONNECTION_URI="<MongoDB connection URI with Atlas Vector Search configured on 'embedded_content'>"
+VECTOR_SEARCH_INDEX_NAME="vector_index" # or whatever your index name is
+MONGODB_DATABASE_NAME="mongodb-chatbot-framework-chatbot" # or whatever your database name is. must contain vector search index.
+
+# OpenAI config
+OPENAI_API_KEY=<OpenAI API key>
+OPENAI_EMBEDDING_MODEL="text-embedding-ada-002" # or other model
+OPENAI_CHAT_COMPLETION_MODEL="gpt-3.5-turbo" # or other model

examples/repo-chat/.gitignore

@@ -0,0 +1,133 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# ts build
+build/

examples/repo-chat/README.md

@@ -0,0 +1,43 @@
+# Repo Chat
+
+Example project for chatting with Git repositories.
+
+The project is structured as a monorepo containing several subprojects.
+
+1. `packages/ingest` - Contains the ingestion script and the configuration.
+2. `packages/server` - Contains the server code.
+3. `packages/ui` - Contains the UI code.
+
+## Setup
+
+1. Get the project from Github
+
+   ```sh
+   git clone https://github.com/mongodb/chatbot.git
+   cd examples/repo-chat
+   ```
+
+2. Set up environment
+
+   ```sh
+   cp .env.example .env
+   ```
+
+   Populate the `.env` file with relevant values. You'll need a MongoDB Atlas connection URI and an OpenAI API key.
+
+3. Install dependencies
+
+   ```sh
+   npm install
+   ```
+
+4. Run the ingestion script
+
+   ```sh
+   npm run ingest:all
+
+5. Start the development server
+
+   ```sh
+   npm run dev
+   ```