Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ocluf/justship

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/ocluf/justship
Owner: ocluf
Created: 2024-02-13T15:34:38.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-05-22T15:00:13.000Z (8 months ago)
Last Synced: 2024-05-22T19:04:03.998Z (8 months ago)
Language: TypeScript
Homepage: https://justship.today
Size: 303 KB
Stars: 226
Watchers: 6
Forks: 14
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome - ocluf/justship - A svelte 5 and sveltekit saas boilerplate. Including database, authentication, email, analytics (TypeScript)

README

# 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 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`
- 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](https://turso.tech/)
- 🔑 Create an OAuth credential in **Google Cloud**
- 🏗️ Set up a project from this repo on **Vercel**: [vercel](https://vercel.com)
- 🎯 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

[![How to use Just Ship](https://img.youtube.com/vi/sJZOXUhkvMc/0.jpg)](https://www.youtube.com/watch?v=sJZOXUhkvMc)