initial example commit

Tavus-Engineering · Sep 10, 2024 · 783012f · 783012f
1 parent 3210731
commit 783012f
Show file tree

Hide file tree

Showing 39 changed files with 6,787 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+.env
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Tavus Examples
+
+Welcome to our collection of demos and projects showcasing the Tavus conversational video interface! 🚀
+
+## 🌟 What's Inside?
+
+This repository is packed with resources that demonstrate how you can build immersive AI-generated video experiences in your application:
+
+- 🤖 Build authentic digital twin experiences
+- 💡 Create advanced use cases for conversational video interfaces
+
+## 💻 Examples
+
+- [CVI Quickstart React](./examples/cvi-quickstart-react)
+
+## 📚 Learn More
+
+Ready to dive deeper? Check out these resources:
+
+- 📖 [Developer Documentation](https://docs.tavus.io/)
+- 🔧 [API Reference](https://docs.tavus.io/api-reference/)
+- 🚀 [Tavus Platform](https://platform.tavus.io/)
+
+Start exploring and happy coding! 🎉
+
+## 📄 License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
diff --git a/examples/cvi-quickstart-react/.gitignore b/examples/cvi-quickstart-react/.gitignore
@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+.env
diff --git a/examples/cvi-quickstart-react/README.md b/examples/cvi-quickstart-react/README.md
@@ -0,0 +1,26 @@
+# Tavus Conversational Video Interface
+
+## 🛠 Getting Started
+
+1. Install dependencies:
+   ```
+   npm install
+   ```
+
+2. Create a `.env` file in the root directory and add your Tavus API key:
+   ```
+   VITE_APP_TAVUS_API_KEY=your_api_key_here
+   ```
+   You can create an API key at https://platform.tavus.io/
+
+3. Start the development server:
+   ```
+   npm run dev
+   ```
+
+## 📚 Learn More
+
+- [Developer Documentation](https://docs.tavus.io/)
+- [API Reference](https://docs.tavus.io/api-reference/)
+- [Tavus Platform](https://platform.tavus.io/)
+- [Daily React Reference](https://docs.daily.co/reference/daily-react)
diff --git a/examples/cvi-quickstart-react/components.json b/examples/cvi-quickstart-react/components.json
@@ -0,0 +1,20 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "default",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.js",
+    "css": "src/index.css",
+    "baseColor": "zinc",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
+  }
+}
diff --git a/examples/cvi-quickstart-react/eslint.config.js b/examples/cvi-quickstart-react/eslint.config.js
@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+)
diff --git a/examples/cvi-quickstart-react/index.html b/examples/cvi-quickstart-react/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <!-- <link rel="icon" type="image/svg+xml" href="/vite.svg" /> -->
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Conversational Video Interface React</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>