feat: local Ollama example (#865)

* feat: local ollama example * update lockfile, rename project,
Yonom · Sep 21, 2024 · 4e60d3a · 4e60d3a
1 parent aca9ead
commit 4e60d3a
Show file tree

Hide file tree

Showing 18 changed files with 394 additions and 9 deletions.
diff --git a/examples/local-ollama/.env.example b/examples/local-ollama/.env.example
@@ -0,0 +1 @@
+OLLAMA_API_URL=
diff --git a/examples/local-ollama/.eslintrc.json b/examples/local-ollama/.eslintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": ["next/core-web-vitals", "next/typescript"]
+}
diff --git a/examples/local-ollama/.gitignore b/examples/local-ollama/.gitignore
@@ -0,0 +1,63 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+.env
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# OS generated files
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+*.cab
+*.msi
+*.msm
+*.msp
diff --git a/examples/local-ollama/README.md b/examples/local-ollama/README.md
@@ -0,0 +1,65 @@
+## Project Overview
+
+This project configures `assistant-ui` to work with Ollama hosted on a local instance. Additionally, it changes the theme to dark mode.
+
+This source code was generated using the `Getting Started` guide hosted on [assistant-ui.com/docs](https://www.assistant-ui.com/docs).
+
+```bash
+npx assistant-ui@latest create my-app
+cd my-app
+```
+
+
+
+## Prerequisites
+
+Ensure you have the following installed:
+
+- Node.js
+- npm
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/yourusername/assistant-ui-local-ollama.git
+cd assistant-ui-local-ollama
+```
+
+Install the dependencies:
+
+```bash
+npm install
+```
+
+## Configuration
+Copy the `.env.local.example` file to `.env`:
+
+Add `OLLAMA_API_URL` to the `.env` file:
+```
+OLLAMA_API_URL=http:/x.x.x.x:11434/api
+```
+
+## Running the Development Server
+
+Start the development server:
+
+```bash
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+## Editing the Project
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+## Changing the Theme to Dark Mode
+
+The theme has been set to dark mode by default. You can customize the theme by annotating html with the className `dark`.
+
+
+## License
+
+This project is licensed under the MIT License.
diff --git a/examples/local-ollama/app/api/chat/route.ts b/examples/local-ollama/app/api/chat/route.ts
@@ -0,0 +1,10 @@
+import { createOllama } from "ollama-ai-provider";
+import { createEdgeRuntimeAPI } from "@assistant-ui/react/edge";
+
+const local_ollama = createOllama({
+  baseURL: process.env.OLLAMA_API_URL,
+});
+
+export const { POST } = createEdgeRuntimeAPI({
+  model: local_ollama("llama3.1"),
+});
diff --git a/examples/local-ollama/app/favicon.ico b/examples/local-ollama/app/favicon.ico
diff --git a/examples/local-ollama/app/fonts/GeistMonoVF.woff b/examples/local-ollama/app/fonts/GeistMonoVF.woff
diff --git a/examples/local-ollama/app/fonts/GeistVF.woff b/examples/local-ollama/app/fonts/GeistVF.woff
diff --git a/examples/local-ollama/app/globals.css b/examples/local-ollama/app/globals.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
diff --git a/examples/local-ollama/app/layout.tsx b/examples/local-ollama/app/layout.tsx
@@ -0,0 +1,35 @@
+import type { Metadata } from "next";
+import localFont from "next/font/local";
+import "./globals.css";
+
+const geistSans = localFont({
+  src: "./fonts/GeistVF.woff",
+  variable: "--font-geist-sans",
+  weight: "100 900",
+});
+const geistMono = localFont({
+  src: "./fonts/GeistMonoVF.woff",
+  variable: "--font-geist-mono",
+  weight: "100 900",
+});
+
+export const metadata: Metadata = {
+  title: "Create Next App",
+  description: "Generated by create next app",
+};
+
+export default function RootLayout({
+  children,
+}: Readonly<{
+  children: React.ReactNode;
+}>) {
+  return (
+    <html lang="en" className="dark">
+      <body
+        className={`${geistSans.variable} ${geistMono.variable} antialiased`}
+      >
+        {children}
+      </body>
+    </html>
+  );
+}
diff --git a/examples/local-ollama/app/page.tsx b/examples/local-ollama/app/page.tsx
@@ -0,0 +1,9 @@
+import { MyAssistant } from "@/components/MyAssistant";
+
+export default function Home() {
+  return (
+    <main className="h-dvh">
+      <MyAssistant />
+    </main>
+  );
+}
diff --git a/examples/local-ollama/components/MyAssistant.tsx b/examples/local-ollama/components/MyAssistant.tsx
@@ -0,0 +1,18 @@
+"use client";
+
+import { useEdgeRuntime } from "@assistant-ui/react";
+import { Thread } from "@assistant-ui/react";
+import { makeMarkdownText } from "@assistant-ui/react-markdown";
+
+const MarkdownText = makeMarkdownText();
+
+export function MyAssistant() {
+  const runtime = useEdgeRuntime({ api: "/api/chat" });
+
+  return (
+    <Thread
+      runtime={runtime}
+      assistantMessage={{ components: { Text: MarkdownText } }}
+    />
+  );
+}
diff --git a/examples/local-ollama/next.config.mjs b/examples/local-ollama/next.config.mjs
@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+export default nextConfig;
diff --git a/examples/local-ollama/package.json b/examples/local-ollama/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "with-local-ollama",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@assistant-ui/react": "^0.5",
+    "@assistant-ui/react-markdown": "^0.2",
+    "next": "14.2.11",
+    "ollama-ai-provider": "^0.15.0",
+    "react": "^18",
+    "react-dom": "^18",
+    "tailwindcss-animate": "^1.0.7",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "eslint": "^8",
+    "eslint-config-next": "14.2.11",
+    "postcss": "^8",
+    "tailwindcss": "^3.4.11",
+    "typescript": "^5"
+  }
+}
diff --git a/examples/local-ollama/postcss.config.mjs b/examples/local-ollama/postcss.config.mjs
@@ -0,0 +1,8 @@
+/** @type {import('postcss-load-config').Config} */
+const config = {
+  plugins: {
+    tailwindcss: {},
+  },
+};
+
+export default config;
diff --git a/examples/local-ollama/tailwind.config.ts b/examples/local-ollama/tailwind.config.ts
@@ -0,0 +1,17 @@
+import type { Config } from "tailwindcss";
+
+const config = {
+  darkMode: "class",
+  content: [
+    "./pages/**/*.{js,ts,jsx,tsx,mdx}",
+    "./components/**/*.{js,ts,jsx,tsx,mdx}",
+    "./app/**/*.{js,ts,jsx,tsx,mdx}",
+  ],
+  plugins: [
+    require("tailwindcss-animate"),
+    require("@assistant-ui/react/tailwindcss"),
+    require("@assistant-ui/react-markdown/tailwindcss"),
+  ],
+} satisfies Config;
+
+export default config;
diff --git a/examples/local-ollama/tsconfig.json b/examples/local-ollama/tsconfig.json
@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}