ak4zh / justship

Home Page:https://justship.today

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Just Ship - SvelteKit Auth Boilerplate πŸš€

IMPORTANT: This template uses svelte 5 even though it is still in alpha. Svelte 5 is close to release but for now use at your own risk

Comes With 🌟

  • πŸšͺ Login with Google and Magic Link with Email (using Lucia)
  • πŸ“§ Resend to send emails
  • πŸ’» Svelte 5
  • 🎨 Tailwind CSS and shadcn-svelte for components (with built-in dark mode)
  • πŸ“¦ Turso for the database
  • πŸ› οΈ Drizzle as ORM
  • ✍️ Superforms 2
  • ☁️ Hosted on Vercel

Getting Started πŸš€

Local Development

  • Run pnpm install or 'npm install --force-legacy-deps'
  • Run Mailpit for email testing: Mailpit Instructions
  • add a .env file with a PUBLIC_PROJECT_NAME variable e.g PUBLIC_PROJECT_NAME="Just Ship"
  • run npm run migrate to initialise a local sqlite database
  • Start the development server with npm run dev
  • remove everything at src/routes/(app)/+page.svelte

Production 🌐

  • 🌍 Get a domain name
  • πŸ“¬ Create a Resend account and set up MX records as per Resend Instructions
  • πŸ’Ύ Set up a database with Turso: Turso Setup
  • πŸ”‘ Create an OAuth credential in Google Cloud
  • πŸ—οΈ Set up a project from this repo on Vercel: link-to-vercel
  • 🎯 Point your main domain name to your project on Vercel
  • πŸ” create a .env at the root level and fill out the environment variables in env.example
  • βš™οΈ Add those environment variables to your project in Vercel

Feel free to contribute or suggest improvements! 🀝

About

https://justship.today


Languages

Language:TypeScript 46.0%Language:Svelte 45.3%Language:JavaScript 5.6%Language:CSS 2.5%Language:HTML 0.6%