Getting Started with Routier
Welcome to Routier! This section will guide you through setting up Routier in your project and getting your first application running.
✨ Explore Before You Install
Try Routier in a live CodeSandbox environment to see schemas, live queries, and React integration in action before setting up your own project.
Quick Navigation
What You’ll Learn
By the end of this getting started guide, you’ll have:
- ✅ Installed Routier and a storage plugin
- ✅ Created your first schema and collection
- ✅ Built a simple application with live queries
- ✅ Understood Routier’s core concepts
Prerequisites
Before you begin, make sure you have:
- Node.js (v16 or higher)
- npm or yarn package manager
- Basic knowledge of TypeScript or JavaScript
- A text editor (VS Code recommended)
Quick Overview
Routier works by:
- Defining schemas - Type-safe data structures with defaults, indexes, and computed properties
- Creating collections - Typed entity sets backed by any storage plugin
- Using live queries - Reactive queries that update automatically when data changes
- Making optimistic mutations - Instant UI updates with automatic rollback on errors
Choose Your Path
🚀 Quick Start (Recommended)
If you want to see Routier in action immediately:
- Quick Start Guide - Build a working example in minutes
📦 Installation First
If you prefer to understand the setup process:
- Installation Guide - Install packages and dependencies
- Quick Start Guide - Then build your first app
⚛️ React Developer
If you’re building with React:
- React Adapter - React hooks and components
⚙️ Advanced Setup
If you need custom configuration:
- Configuration Guide - Advanced setup options
Next Steps
Once you’ve completed the getting started guide:
- Learn the concepts: Schema Guide - Deep dive into data modeling
- Explore features: Live Queries - Reactive data patterns
- Check out React: React Integration - Use Routier with React
- Browse plugins: Built-in Plugins - Available storage options
Need Help?
- 📖 Documentation: Browse our comprehensive guides and API reference
- 💬 Community: Join discussions and get help from other developers
- 🐛 Issues: Report bugs or request features on GitHub