Skip to content

Commit

Permalink
switched back to single repo instead of a CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
ocluf committed Jun 5, 2024
1 parent 17625b1 commit 96a9d2c
Show file tree
Hide file tree
Showing 113 changed files with 2,405 additions and 10,780 deletions.
3 changes: 1 addition & 2 deletions website/.gitignore → .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@
node_modules
/build
/.svelte-kit
.vite
/package
.env
.env.*
!.env.example
vite.config.js.timestamp-*
vite.config.ts.timestamp-*
local.db
local.db
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
engine-strict=true
File renamed without changes.
File renamed without changes.
42 changes: 32 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
# Just Ship - An easy to setup Svelte 5 SaaS Boilerplate
# Just Ship - An batteries included Svelte 5 SaaS Boilerplate

### Comes With

- 🚪 **Login with Google** and **Magic Link** (using Lucia)
- 📧 **Resend** to send emails
- 💻 **Svelte 5**
- 🎨 **Tailwind CSS** and **daisy-ui** for styling
- 📦 **Turso** for the database and super easy local development
- 🛠️ **Drizzle** as ORM
- ☁️ Easily hosted with free tier on **Vercel**
- 💻 **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

- Simply run `npm create justship@latest`
- Run `npm 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 **Resend** account and set up MX records as per [Resend Instructions](https://resend.com/domains)
- 📬 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)
Expand All @@ -28,3 +31,22 @@
- ⚙️ Add those environment variables to your project in Vercel

Feel free to contribute or suggest improvements! 🤝

### Roadmap

- [x] SEO Setup
- [x] 404 page
- [x] Replace Resend with Postmark
- [ ] Landing page components
- [x] Hero
- [x] FAQ
- [x] Personal Story
- [x] Footer
- [x] Pricing
- [x] Features
- [ ] Problem Agition
- [ ] Wall of Love
- [ ] Blog Section
- [ ] Add rate limiting to email login
- [ ] docs
- [ ] Improve stripe section
2 changes: 0 additions & 2 deletions create-justship/.gitignore

This file was deleted.

132 changes: 0 additions & 132 deletions create-justship/bin.js

This file was deleted.

Loading

0 comments on commit 96a9d2c

Please sign in to comment.