SvelteKit Omakase

Welcome to SvelteKit Omakase (formerly Kickoff SvelteKit), a starter project designed to get you up and running with SvelteKit 🚀.

This project embraces an omakase approach, inspired by the Rails doctrine. It offers an opinionated selection of tools and a structured approach, providing a robust foundation while allowing you the flexibility to customize and extend it as needed.

Table of Contents

• SvelteKit Omakase
  • Table of Contents
  • Demo
  • Getting Started
  • Features
  • Built With
  • Documentation
  • Contributing
  • Acknowledgments
  • Notes

Demo

Demo

Getting Started

Clone this repository, install dependencies, set your environment variables (refer to .env.example for the required environment variables), and kick off your project!

Features

• Authentication (Registration, Login, Password Reset, etc.)
• Personal & Team Accounts (including invites)
• File Uploads
• Mailer (with previews in development environment)
• Responsive Design
• Light & Dark Themes
• And more...

Built With

• 👍 SvelteKit
• 5️⃣ Svelte 5
• 💨 TailwindCSS
• 💾 Drizzle ORM
• 🎨 shadcn-svelte
• 📬 SendGrid API
• ⛔ Zod
• 📄 SvelteKit SuperForms
• 📁 AWS S3

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

Your contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Acknowledgments

This project makes use of some great tools and libraries and could not have come to life without the incredible contributions of these individuals to the open-source community:

• Hunter Johnston (huntabyte)
• Andreas Söderlund (ciscoheat)
• pilcrow
• Carsten Lebek - carstenlebek

Notes

If you are looking for the archived Postgres-compatible version, please check the V1 branch. However, please be aware that this version is no longer maintained. We highly recommend using the new and improved SvelteKit Omakase version, which features significant enhancements and will be regularly maintained. Transitioning to this version is straightforward and offers a better development experience compared to the older version.