Skip to content

A modern, full-stack web application boilerplate built with speed and developer experience in mind.

Notifications You must be signed in to change notification settings

osmanorhan/breeze-stack

Repository files navigation

Breeze Stack 🌪️

A modern, full-stack web application boilerplate built with speed and developer experience in mind.

Tech Stack 🛠️

  • React Router v7 - Next generation routing with file-based routing, type safety, and server components
  • Prisma ORM - Next-generation Node.js and TypeScript ORM
  • Better Auth - Simple and secure authentication
  • Turso - Distributed SQLite database built on libSQL
  • shadcn/ui - Re-usable components built with Radix UI and Tailwind CSS
  • Tailwind CSS - Utility-first CSS framework
  • Conform - Form validation and state management
  • Zod - TypeScript-first schema validation

Getting Started 🚀

Prerequisites

  1. Node.js 18+ and pnpm
  2. Turso CLI installed (brew install tursodatabase/tap/turso)
  3. Git

Setting up Turso Database

  1. Sign up for a free account at Turso
  2. Create a new database:
    turso db create [your-db-name]
  3. Get your database URL and authentication token:
    turso db show [your-db-name]
    turso db tokens create [your-db-name]

Installation

  1. Clone the repository:

    git clone https://github.com/osmanorhan/breeze-stack.git
    cd breeze-stack
  2. Install dependencies:

    pnpm install
  3. Create a .env file:

    DATABASE_URL="libsql://[your-db-url]"
    DATABASE_AUTH_TOKEN="[your-token]"
    SESSION_SECRET="[your-session-secret]"
    
  4. Generate Prisma client:

    pnpm run db:generate
  5. Generate auth tables:

    pnpm dlx @better-auth/cli generate --config ./app/lib/auth.server.ts
  6. Apply migrations:

    pnpm dlx prisma migrate dev --name init
  7. Apply initial migrations to Turso:

    turso db shell [your-db-name] < ./prisma/migrations/20250104172246_init/migration.sql

Development

Start the development server:

pnpm run dev

Project Structure 📁

├── app/
│   ├── components/        # Reusable components
│   ├── lib/              # Utilities and configurations
│   ├── routes/           # File-based routing
│   └── styles/           # Global styles
├── prisma/
│   ├── migrations/       # Database migrations
│   └── schema.prisma     # Database schema

Database Migrations 🔄

When making changes to the schema:

  1. Update prisma/schema.prisma
  2. Generate migration:
    npx prisma migrate dev --name [descriptive-name]
  3. Apply to Turso:
    turso db shell [your-db-name] < ./prisma/migrations/[timestamp]_[name]/migration.sql

Authentication 🔐

Authentication is handled by Better Auth. The setup includes:

  • Email/Password authentication
  • OAuth providers (Google)
  • Session management
  • Protected routes

Features ✨

  • 🎯 Type-safe routing and data loading
  • 🔒 Built-in authentication with multiple providers
  • 📱 Responsive layout with modern UI components
  • 🎨 Dark mode support
  • 🔍 Form validation with schema-based approach
  • 🚀 Fast development workflow
  • 📦 Pre-built components and layouts

License 📝

MIT

Roadmap

Roadmap 🗺️

Upcoming Features 🚀

Authentication & Authorization

  • Role-based access control (RBAC)
  • Team/Organization support
  • Two-factor authentication (2FA)
  • Password reset flow
  • Email verification

UI/UX Improvements

  • Advanced table features (sorting, filtering, pagination)
  • File upload support with object storage
  • Rich text editor integration (Lexical?)
  • Dashboard analytics and charts
  • Notification system
  • Search functionality (add Meili?)
  • SVG

Developer Experience

  • API documentation with Swagger/OpenAPI
  • Unit and integration testing setup
  • GitHub Actions CI/CD pipeline
  • Performance monitoring
  • Error tracking integration

Infrastructure

  • WebSocket support for real-time features
  • Background job processing
  • Caching layer

Recently Completed ✅

  • Basic authentication flow
  • Project CRUD operations
  • Form validation with Conform
  • Responsive dashboard layout
  • Dark mode support
  • Database migrations

Contributing 🤝

Contributions are welcome! Please feel free to submit a Pull Request. Check our roadmap for planned features or suggest new ones.

About

A modern, full-stack web application boilerplate built with speed and developer experience in mind.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published