Skriuw Documentation

Welcome to the Skriuw documentation! Skriuw is a local-first, near-instant sync note-taking application built with Tauri 2.0, Next.js, and InstantDB.

What is Skriuw?

Skriuw is a modern note-taking application that combines the best of desktop and web experiences:

• Local-First Architecture - Your data lives on your device first
• Near-Instant Sync - Changes sync across devices seamlessly
• Cross-Platform - Desktop app (Tauri) and web app (Next.js)
• Offline Support - Works without an internet connection
• Real-Time Collaboration - Powered by InstantDB

Project Structure

The Skriuw monorepo consists of:

Applications

• Tauri App (apps/instantdb) - Desktop application built with Tauri 2.0
• Web App (apps/instantdb) - Next.js web application
• Documentation (apps/docs) - This documentation site (Fumadocs)

Tools

• SK (tools/sk) - Interactive CLI for managing the monorepo
• Seeder (tools/seeder) - Database seeding utilities

Quick Start

Using SK (Recommended)

The easiest way to get started:

# From project root
bun run cli

# Or use the short alias
bun run sk

This launches an interactive menu where you can:

• Start/stop apps
• Build for production
• Deploy to Vercel
• Manage running processes
• Run tools like the seeder

Manual Setup

# Install dependencies
bun install

# Run the main app
cd apps/instantdb
bun run dev

# Run the docs site
cd apps/docs
bun run dev

Documentation Sections

Tech Stack

Core Technologies

• Tauri 2.0 - Desktop application framework
• Next.js 15 - React framework with TypeScript
• InstantDB - Real-time database with offline support
• TypeScript - Type-safe development
• Tailwind CSS - Utility-first styling
• TipTap - Rich text editor

Development Tools

• Bun - Fast JavaScript runtime and package manager
• Fumadocs - Documentation framework
• Vercel - Deployment platform

Getting Help

• SK Issues? Check the SK Troubleshooting guide
• Development Questions? See the Tauri App or Web App docs
• Database Setup? Review the Seeder Tool documentation

Contributing

We welcome contributions! Here's how to get started:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test using SK
5. Submit a pull request

For more details, see the individual documentation sections for each component.

License

MIT License - see LICENSE file for details.