Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.59 KB

README.md

File metadata and controls

39 lines (29 loc) · 1.59 KB

Just Ship - A batteries included Svelte 5 SaaS Boilerplate

Comes With

  • 💻 Svelte 5 and SvelteKit 2
  • 🚪 Auth (both social and magic link, using Lucia)
  • 📧 Sending Emails (using Postmark)
  • 🎨 Styling (using tailwindcss and shadcn)
  • 📦 Database (using turso and drizzle as ORM)
  • ☁️ Serverless hosting using vercel

Getting Started 🚀

Local Development

  • Run pnpm install
  • Rename the .env.example file to .env and populate it with your own values
  • Run npm run generate && npm run migrate to create a local database
  • Install mailpit to receive emails locally https://mailpit.axllent.org/docs/install/
  • run npm run dev

Production 🌐

  • 🌍 Get a domain name
  • 📬 Create a postmark account and get the server api key
  • 💾 Set up a database with Turso: Turso Setup
  • 🔑 Create an OAuth credential in Google Cloud
  • 🏗️ Set up a project from this repo on Vercel: vercel
  • 🎯 Point your main domain name to your project on Vercel
  • 🔐 fill out the environment variables in .env
  • ⚙️ Add those environment variables to your project in Vercel

Feel free to contribute or suggest improvements! 🤝

How to setup Just Ship the youtube tutorial

(note this tutorial is slightly outdated) You don't need mailpit neccesarily I log the email login link in the console. I also use shadcn now instead of daisyUI

How to use Just Ship