search

geraldmuvengei06 / nuxt-saas-starter

https://nuxt-saas-starter.vercel.app
MIT License
2 stars 1 forks source link

readme

Nuxt.js SaaS Starter

[!IMPORTANT]
This repo is a work-in-progress. Please open an issue if you see something wrong!

This is a starter template for building a SaaS application using Nuxt.js with support for authentication, Stripe integration for payments, and a dashboard for logged-in users.

Demo: https://nuxt-saas-start.vercel.app/

Wait, why make this? In 2020, I made a course called "React 2025" which showed how to build a SaaS application with Nuxt.js, Stripe, and other tools. Well, it's almost 2025 and React 19 has brought so many amazing new features I didn't predict! This repo is a demonstration of the latest React and Nuxt.js patterns. These patterns can drastically simplify some common tasks in building your SaaS, like building forms, talking to your database, and more. For example, React now has built in hooks like `useActionState` to handle inline form errors and pending states. React Server Actions can replace a lot of boilerplate code needed to call an API Route from the client-side. And finally, the React `use` hook combined with Nuxt.js makes it incredibly easy to build a powerful `useUser()` hook. We're able to fetch the user from our Postgres database in the root layout, but _not_ await the `Promise`. Instead, we forward the `Promise` to a React context provider, where we can "unwrap" it and awaited the streamed in data. This means we can have the best of both worlds: easy code to fetch data from our database (e.g. `getUser()`) and a React hook we can use in Client Components (e.g. `useUser()`). Fun fact: the majority of the UI for this application was built with [v0](https://v0.dev) 🤯 [More details here](https://x.com/leeerob/status/1835777934361084316) if you want to learn about this repo.

Features

Tech Stack

Getting Started

git clone https://github.com/geraldmuvengei06/nuxt-saas-starter
cd nuxt-saas-starter
pnpm install
pnpm db:setup
pnpm db:migrate
pnpm db:seed

Running the setup script will create your .env file locally.

Running Locally

Once you have set up the environment variables and installed dependencies, run the development server:

pnpm dev

Then, also listen for Stripe webhooks locally through their CLI:

stripe listen --forward-to localhost:3000/api/stripe/webhook

Open http://localhost:3000 in your browser to see the app in action.

Testing Payments

To test Stripe payments, use the following test card details:

Going to Production

When you're ready to deploy your SaaS application to production, follow these steps:

Set up a production Stripe webhook

  1. Go to the Stripe Dashboard and create a new webhook for your production environment.
  2. Set the endpoint URL to your production API route (e.g., https://yourdomain.com/api/stripe/webhook).
  3. Select the events you want to listen for (e.g., checkout.session.completed, customer.subscription.updated).

Deploy to Vercel

  1. Push your code to a GitHub repository.
  2. Connect your repository to Vercel and deploy it.
  3. Follow the Vercel deployment process, which will guide you through setting up your project.

Add environment variables

In your Vercel project settings (or during deployment), add all the necessary environment variables. Make sure to update the values for the production environment, including:

  1. BASE_URL: Set this to your production domain.
  2. STRIPE_SECRET_KEY: Use your Stripe secret key for the production environment.
  3. STRIPE_WEBHOOK_SECRET: Use the webhook secret from the production webhook you created in step 1.
  4. DATABASE_URL: Set this to your production database URL.
  5. AUTH_SECRET: Set this to a random string. openssl rand -base64 32 will generate one.

Other Templates

While this template is intentionally minimal and to be used as a learning resource, there are other paid versions in the community which are more full-featured:

License

This project is licensed under the MIT License. See the LICENSE file for details.