xonecas.io
53129
Pa

PAT / commit 147c7c8

feat: readme

xonecas2025-12-16 147c7c8f25a10feeb911a568c562ee667b359f2d parent e236b80

2 files changed

README.md+77−0
@@ -0,0 +1,77 @@
1+# Personal Assistant Thing
2+
3+A minimal web-based personal assistant that connects to local Ollama models for chat conversations. Built with Next.js, TypeScript, and TailwindCSS.
4+
5+## Features
6+
7+- Chat interface with conversation threads
8+- Local LLM integration via Ollama
9+- Persistent conversation history (SQLite)
10+- Markdown rendering with syntax highlighting
11+- Dark/light mode support
12+- Keyboard shortcuts for message history
13+
14+## Prerequisites
15+
16+- Node.js 20+ and npm
17+- [Ollama](https://ollama.ai/) installed and running locally
18+- At least one Ollama model pulled (default: `gpt-oss`)
19+
20+## Installation
21+
22+```bash
23+npm install
24+```
25+
26+## Setup
27+
28+Run database migrations:
29+
30+```bash
31+npm run db:migrate
32+```
33+
34+## Development
35+
36+Start the development server:
37+
38+```bash
39+npm run dev
40+```
41+
42+Open [http://localhost:3000](http://localhost:3000) in your browser.
43+
44+## Available Scripts
45+
46+- `npm run dev` - Start development server
47+- `npm run build` - Build for production
48+- `npm run start` - Start production server
49+- `npm run lint` - Run ESLint
50+- `npm run format` - Format code with Prettier
51+- `npm run db:generate` - Generate database migrations
52+- `npm run db:migrate` - Run database migrations
53+- `npm run db:studio` - Open Drizzle Studio
54+
55+## Usage
56+
57+1. Create a new thread or select an existing one from the sidebar
58+2. Type your message and press Enter (or click Send)
59+3. Use Arrow Up/Down keys to navigate through message history
60+4. Toggle theme using the theme selector in the sidebar
61+
62+## Project Structure
63+
64+- `app/` - Next.js App Router pages and API routes
65+- `src/components/` - React components
66+- `src/lib/` - Utility functions (Ollama client, database)
67+- `src/types.ts` - TypeScript type definitions
68+- `data/` - SQLite database (created automatically)
69+
70+## Tech Stack
71+
72+- **Framework**: Next.js 16
73+- **Language**: TypeScript
74+- **Styling**: TailwindCSS
75+- **Database**: SQLite with Drizzle ORM
76+- **LLM**: Ollama
77+
TODO.md+3−1
@@ -7,4 +7,6 @@
77 ## New features:
88
99 - Text input, we should be able to press a button and record a prompt.
10-- Text to voice, we should have a button to have the models replies be read with text to voice.
10+- Text to voice, we should have a button to have the models replies be read with text to voice.
11+- Select the ollama model to use for the thread
12+- Add a context prompt, something to be sent seting the tone of the conversation