Skip to content
/ sveltekit-omakase Public template

SvelteKit Omakase is a starter project designed to get you up and running with SvelteKit πŸš€

Notifications You must be signed in to change notification settings

n00ki/sveltekit-omakase

Repository files navigation

SvelteKit Omakase

Overview

Welcome to SvelteKit Omakase, the ultimate mise en place for your next SvelteKit project πŸš€.

Inspired by the Rails doctrine, this project embraces an omakase approachβ€”offering an opinionated selection of tools and a structured foundation while giving you the freedom to customize and extend as needed. Whether you're a seasoned developer or just starting out, this starter kit is carefully curated to get you up and running with SvelteKit by providing everything you need to build modern, scalable web applications with ease.

Table of Contents

Features

  • 🎨 Modern, Responsive & Accessible UI
  • πŸ”’ Robust Authentication
  • πŸ‘₯ Teams/Accounts Management
  • πŸŽ›οΈ Customizable Dashboard
  • πŸ“ File Storage
  • πŸ“§ Transactional Email
  • πŸ› οΈ Developer Utilities & DX Enhancements

Tech Stack

Getting Started

Installation

# Clone the repository
git clone https://github.com/n00ki/sveltekit-omakase.git my-app
cd my-app

# Install dependencies (SvelteKit Omakase is tailored for pnpm, but you can use any package manager you like)
pnpm install

# Setup environment variables
cp .env.example .env
# Edit .env with your configuration

# Initialize the database locally
pnpm db:push

# Start the development server
pnpm dev

Project Structure

src/
β”œβ”€β”€ lib/             # Library code
β”‚   β”œβ”€β”€ components/  # UI components
β”‚   β”œβ”€β”€ db/          # Database models and queries
β”‚   β”œβ”€β”€ server/      # Server-only code
β”‚   └── utils/       # Utility functions
β”œβ”€β”€ routes/          # SvelteKit routes
β”‚   β”œβ”€β”€ (auth)/      # Authentication routes
β”‚   └── (dashboard)/ # Protected dashboard routes
└── styles/          # Global styles

Documentation

Comprehensive documentation is in the works. In the meantime, we encourage you to dive into the codebase and explore. Should you encounter any difficulties or have questions, please don't hesitate to reach out. Your contributions towards improving documentation are also welcome!

Contributing

Contributions are welcome! Please feel free to submit a Pull Request πŸ’ͺ

Acknowledgments

Special thanks to these incredible contributors to the open-source community:

About

SvelteKit Omakase is a starter project designed to get you up and running with SvelteKit πŸš€

Resources

Stars

Watchers

Forks