Organized App

Your everyday companion app

Contributing

Tech Stack

This app is made with

• SvelteKit
• Shadcn
• UnoCSS
• Tauri
• Bun
• Drizzle
• @yuo-app/lin

See documentation for each to get started.

Prerequisites

• Bun
• Tauri
• VSCode (recommended)
• You should also install all recommended VSCode extensions from the .vscode/extensions.json file.

Setup

Example commands use @antfu/ni.

ni # Install dependencies
nr sync # Sync svelte types
nr desktop # Start desktop dev build + creates database
nlx eemoji init -c none # Initialize automatic commit emojis

If you wish to use the lin tool, you need to set up the environment variables in the .env file. You can use the .env.example as a template.

Commands

Start development server

nr desktop # Target: Windows, Linux, MacOS
nr android # Target: Android

Build

nr build:desktop
nr build:android

Android build requirees distribution setup.

Database

nr db:generate # Generate SQL migrations
nr db:migrate # Apply migrations
nr db:push # Push schema changes without SQL file generations
nr db:studio # Start real time SQL explorer

For more information, check the documentation.

Other

nr add <component> # Add shadcn component
nr lint # Eslint check and fix
nr lin <command> [options] # Run lin commands
nr tauri <command> [options] # Run tauri commands