Giter Site home page Giter Site logo

just-ship-tutorial's Introduction

Just Ship - An batteries included Svelte 5 SaaS Boilerplate

Comes With

  • ๐Ÿ’ป Svelte 5 and sveltekit 2
  • ๐Ÿšช Auth (both social and with magic link, using Lucia)
  • ๐Ÿ“ง Sending Emails (using Postmark)
  • ๐ŸŽจ Styling (using tailwindcss and daisyUI )
  • ๐Ÿ“ฆ Database (using turso and drizzle as ORM)
  • โ˜๏ธ Serverless hosting using vercel

Getting Started ๐Ÿš€

Local Development

  • Run npm install --legacy-peer-deps or pnpm install
  • Create a .env file and copy over .env.example
  • 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! ๐Ÿค

Roadmap

  • SEO Setup
  • 404 page
  • Replace Resend with Postmark
  • Landing page components
  • docs
    • Hero
    • FAQ
    • Personal Story
    • Footer
    • Pricing
    • Features
    • Problem Agition
    • Wall of Love
  • Blog Section
  • Add rate limiting to email login
  • Improve stripe section

just-ship-tutorial's People

Contributors

ocluf avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.