SaaS-Boilerplate

🚀🎉📚 SaaS Boilerplate built with Next.js + Tailwind CSS + Shadcn UI + TypeScript. ⚡️ Full-stack React application with Auth, Multi-tenancy, Roles & Permissions, i18n, Landing Page, DB, Logging, Testing

3,448

463

3,448

View on GitHub

Top Related Projects

nextjs-subscription-payments

6,463

Clone, deploy, and fully customize a SaaS subscription application with Next.js.

nextui

21,733

🚀 Beautiful, fast and modern React UI library.

saas-ui

1,300

The React component library for startups, built with Chakra UI.

saas-starter-kit

3,227

🔥 Enterprise SaaS Starter Kit - Kickstart your enterprise app development with the Next.js SaaS boilerplate 🚀

domain-driven-hexagon

11,945

Learn Domain-Driven Design, software architecture, design patterns, best practices. Code examples included

Quick Overview

The SaaS-Boilerplate repository is a comprehensive starter kit for building a Software as a Service (SaaS) application. It provides a well-structured and opinionated foundation, including features such as authentication, user management, and a dashboard, to help developers kickstart their SaaS projects.

Pros

Comprehensive Functionality: The boilerplate includes a wide range of features, such as authentication, user management, and a dashboard, which can save developers significant time and effort in setting up the core functionality of a SaaS application.
Modern Tech Stack: The project utilizes a modern tech stack, including React, Next.js, and TypeScript, ensuring that the codebase is maintainable and scalable.
Responsive and Mobile-Friendly: The boilerplate includes a responsive design, making the application accessible and user-friendly across different devices and screen sizes.
Customizable: The project is designed to be easily customizable, allowing developers to build upon the existing foundation and tailor the application to their specific needs.

Cons

Opinionated: The boilerplate is quite opinionated in its choices of technologies and architectural patterns, which may not align with the preferences of all developers.
Steep Learning Curve: Developers who are not familiar with the technologies used in the boilerplate (e.g., Next.js, TypeScript) may face a steeper learning curve when getting started with the project.
Potential Overhead: The comprehensive nature of the boilerplate may introduce some overhead, especially for smaller projects that may not require all the features included.
Limited Documentation: While the project includes some documentation, it may not be as extensive as some developers would prefer, especially for more advanced use cases.

Getting Started

To get started with the SaaS-Boilerplate, follow these steps:

Clone the repository:

git clone https://github.com/ixartz/SaaS-Boilerplate.git

Install the dependencies:

cd SaaS-Boilerplate
npm install

Start the development server:

npm run dev

This will start the development server and open the application in your default web browser. You can now start customizing the boilerplate to fit your specific needs.

Competitor Comparisons

nextjs-subscription-payments

6,463

Clone, deploy, and fully customize a SaaS subscription application with Next.js.

Pros of nextjs-subscription-payments

Simpler setup and configuration, ideal for quick prototyping
Direct integration with Vercel, offering seamless deployment
Focused specifically on subscription payments, providing a streamlined solution

Cons of nextjs-subscription-payments

Less comprehensive feature set compared to SaaS-Boilerplate
Limited customization options for complex SaaS applications
Lacks built-in authentication and user management features

Code Comparison

SaaS-Boilerplate:

import { useSession } from 'next-auth/react';
import { useRouter } from 'next/router';
import { useEffect } from 'react';

export const withAuth = (WrappedComponent: React.ComponentType) => {
  // ... (authentication logic)
};

nextjs-subscription-payments:

import { useUser } from '@/utils/useUser';
import { useRouter } from 'next/router';

const withAuth = (WrappedComponent) => (props) => {
  const { user, isLoading } = useUser();
  // ... (simpler authentication check)
};

The code comparison shows that SaaS-Boilerplate uses Next-Auth for authentication, while nextjs-subscription-payments implements a custom useUser hook. SaaS-Boilerplate's approach offers more flexibility and features, whereas nextjs-subscription-payments focuses on a simpler, more specific implementation.

nextui

21,733

🚀 Beautiful, fast and modern React UI library.

Pros of NextUI

Comprehensive UI component library with a modern, customizable design
Built-in dark mode support and easy theming capabilities
Extensive documentation and examples for quick implementation

Cons of NextUI

Focused solely on UI components, lacking full-stack SaaS features
May require additional setup for backend integration and authentication
Less opinionated about project structure and architecture

Code Comparison

NextUI component usage:

import { Button } from "@nextui-org/react";

export default function App() {
  return <Button>Click me</Button>;
}

SaaS-Boilerplate component usage:

import Button from '@/components/Button';

export default function App() {
  return <Button>Click me</Button>;
}

NextUI offers a more extensive set of pre-built UI components, while SaaS-Boilerplate provides a full-stack solution with authentication, database integration, and payment processing out of the box. NextUI is ideal for projects focusing on UI development, whereas SaaS-Boilerplate is better suited for rapidly building complete SaaS applications with less emphasis on customizable UI components.

saas-ui

1,300

The React component library for startups, built with Chakra UI.

Pros of SaaS UI

Comprehensive UI component library specifically designed for SaaS applications
Built on top of Chakra UI, providing a solid foundation and customization options
Includes advanced features like authentication flows and subscription management

Cons of SaaS UI

Less opinionated about backend technology, which may require more setup for full-stack projects
Focused primarily on UI components, potentially requiring additional integration for complete SaaS functionality
May have a steeper learning curve for developers not familiar with Chakra UI

Code Comparison

SaaS UI component usage:

import { Button, Card, CardBody, CardHeader } from '@saas-ui/react'

function Example() {
  return (
    <Card>
      <CardHeader>Title</CardHeader>
      <CardBody>Content</CardBody>
      <Button>Action</Button>
    </Card>
  )
}

SaaS Boilerplate component usage:

import { Button } from '@/components/Button'
import { Card } from '@/components/Card'

function Example() {
  return (
    <Card title="Title">
      <p>Content</p>
      <Button>Action</Button>
    </Card>
  )
}

Both repositories offer valuable tools for building SaaS applications, with SaaS UI providing a more comprehensive UI library and SaaS Boilerplate offering a full-stack solution with integrated backend services.

saas-starter-kit

3,227

🔥 Enterprise SaaS Starter Kit - Kickstart your enterprise app development with the Next.js SaaS boilerplate 🚀

Pros of saas-starter-kit

Offers a more comprehensive enterprise-ready solution with features like multi-tenancy and SAML SSO
Includes built-in analytics and reporting capabilities
Provides a more scalable architecture suitable for larger applications

Cons of saas-starter-kit

Less focus on frontend design and UI components compared to SaaS-Boilerplate
May have a steeper learning curve due to its more complex architecture
Fewer integrations with third-party services out of the box

Code Comparison

SaaS-Boilerplate (Next.js API route):

export default async function handler(req, res) {
  const session = await getSession({ req });
  if (!session) return res.status(401).json({ error: 'Unauthorized' });
  // Handle authenticated request
}

saas-starter-kit (Express.js route):

app.get('/api/protected', authMiddleware, async (req, res) => {
  try {
    // Handle authenticated request
  } catch (error) {
    res.status(500).json({ error: 'Internal Server Error' });
  }
});

Both projects use similar approaches for handling authenticated routes, but saas-starter-kit uses Express.js middleware for authentication, while SaaS-Boilerplate leverages Next.js API routes with built-in session handling.

domain-driven-hexagon

11,945

Learn Domain-Driven Design, software architecture, design patterns, best practices. Code examples included

Pros of domain-driven-hexagon

Focuses on Domain-Driven Design (DDD) and hexagonal architecture principles
Provides a comprehensive guide on best practices for building scalable applications
Includes detailed explanations and examples of various design patterns

Cons of domain-driven-hexagon

Lacks a full-stack implementation, primarily focusing on backend architecture
Does not include built-in authentication or user management features
May have a steeper learning curve for developers new to DDD concepts

Code Comparison

domain-driven-hexagon:

export class CreateUserUseCase implements UseCase<CreateUserDTO, User> {
  constructor(private readonly userRepo: UserRepository) {}

  async execute(request: CreateUserDTO): Promise<User> {
    const user = User.create(request);
    return this.userRepo.save(user);
  }
}

SaaS-Boilerplate:

export const createUser = async (input: CreateUserInput) => {
  const user = await prisma.user.create({
    data: {
      email: input.email,
      name: input.name,
    },
  });
  return user;
};

The domain-driven-hexagon example demonstrates a more structured approach with clear separation of concerns, while SaaS-Boilerplate offers a simpler, more direct implementation using Prisma ORM.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Boilerplate and Starter for Next JS 14+, Tailwind CSS 3.4 and TypeScript for building SaaS

ð Boilerplate and Starter for building SaaS with Next.js using App Router, Tailwind CSS and TypeScript â¡ï¸ Made with developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Vitest (replacing Jest), Testing Library, Commitlint, VSCode, PostCSS, Tailwind CSS, Authentication with Clerk, Database with DrizzleORM (PostgreSQL, SQLite, and MySQL), Error Monitoring with Sentry, Logging with Pino.js and Log Management, Monitoring as Code, Storybook, Multi-language (i18n), and more. Ready for Next.js 15.

Clone this project and use it to create your own SaaS. You can check the live demo at SaaS Boilerplate, a demo with a working authentication and multi-tenancy system.

Sponsors


Add your logo here

Demo

Live demo: SaaS Boilerplate

Landing Page	User Dashboard

Team Management	User Profile

Sign Up	Sign In

Features

Developer experience first, extremely flexible code structure and only keep what you need:

â¡ Next.js with App Router support
ð¥ Type checking TypeScript
ð Integrate with Tailwind CSS and Shadcn UI
â Strict Mode for TypeScript and React 18
ð Authentication with Clerk: Sign up, Sign in, Sign out, Forgot password, Reset password, and more.
ð¤ Passwordless Authentication with Magic Links, Multi-Factor Auth (MFA), Social Auth (Google, Facebook, Twitter, GitHub, Apple, and more), Passwordless login with Passkeys, User Impersonation
ð¥ Multi-tenancy & team support: create, switch, update organization and invite team members
ð Role-based access control and permissions
ð¤ Multi-Factor Auth (MFA), Social Auth (Google, Facebook, Twitter, GitHub, Apple, and more), User Impersonation
ð¦ Type-safe ORM with DrizzleORM, compatible with PostgreSQL, SQLite, and MySQL
ð Multi-language (i18n) with next-intl and Crowdin
â»ï¸ Type-safe environment variables with T3 Env
â¨ï¸ Form with React Hook Form
ð´ Validation library with Zod
ð Linter with ESLint (default NextJS, NextJS Core Web Vitals, Tailwind CSS and Airbnb configuration)
ð Code Formatter with Prettier
ð¦ Husky for Git Hooks
ð« Lint-staged for running linters on Git staged files
ð Lint git commit with Commitlint
ð Write standard compliant commit messages with Commitizen
ð¦º Unit Testing with Vitest and React Testing Library
ð§ª Integration and E2E Testing with Playwright
ð· Run tests on pull request with GitHub Actions
ð Storybook for UI development
ð¨ Error Monitoring with Sentry
âï¸ Code coverage with Codecov
ð Logging with Pino.js and Log Management with Better Stack
ð¥ï¸ Monitoring as Code with Checkly
ð Automatic changelog generation with Semantic Release
ð Visual testing with Percy (Optional)
ð¡ Absolute Imports using @ prefix
ð VSCode configuration: Debug, Settings, Tasks and Extensions
ð¤ SEO metadata, JSON-LD and Open Graph tags
ðºï¸ Sitemap.xml and robots.txt
â Database exploration with Drizzle Studio and CLI migration tool with Drizzle Kit
âï¸ Bundler Analyzer
ð Include a FREE minimalist theme
ð¯ Maximize lighthouse score

Built-in feature from Next.js:

â Minify HTML & CSS
ð¨ Live reload
â Cache busting

Philosophy

Nothing is hidden from you, so you have the freedom to make the necessary adjustments to fit your needs and preferences.
Dependencies are updated every month
Easy to customize
Minimal code
SEO-friendly
Everything you need to build a SaaS
ð Production-ready

Requirements

Node.js 20+ and npm

Getting started

Run the following command on your local environment:

git clone --depth=1 https://github.com/ixartz/Next-js-Boilerplate.git my-project-name
cd my-project-name
npm install

For your information, all dependencies are updated every month.

Then, you can run the project locally in development mode with live reload by executing:

npm run dev

Open http://localhost:3000 with your favorite browser to see your project.

Set up authentication

Create a Clerk account at Clerk.com and create a new application in Clerk Dashboard. Then, copy NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY into .env.local file (not tracked by Git):

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_pub_key
CLERK_SECRET_KEY=your_clerk_secret_key

Now, you have a fully working authentication system with Next.js: Sign up, Sign in, Sign out, Forgot password, Reset password, Update profile, Update password, Update email, Delete account, and more.

Set up remote database

The project uses DrizzleORM, a type-safe ORM compatible with PostgreSQL, SQLite, and MySQL databases. By default, the project is set up to work seamlessly with PostgreSQL and you can easily choose any PostgreSQL database provider.

Translation (i18n) setup

For translation, the project uses next-intl combined with Crowdin. As a developer, you only need to take care of the English (or another default language) version. Other languages are automatically generated and handled by Crowdin. You can use Crowdin to collaborate with your translation team or translate the messages yourself with the help of machine translation.

To set up translation (i18n), create an account at Crowdin.com and create a new project. In the newly created project, you will able to find the project ID. You'll also require to create a new Personal Access Tokens by going to Account Settings > API. Then, in your GitHub Actions, you need to define the following environment variables CROWDIN_PROJECT_ID and CROWDIN_PERSONAL_TOKEN.

After defining the environment variables in your GitHub Actions, your localization files will be synchronized with Crowdin everytime you push a new commit to the main branch.

Project structure

.
âââ README.md                       # README file
âââ .github                         # GitHub folder
âââ .husky                          # Husky configuration
âââ .storybook                      # Storybook folder
âââ .vscode                         # VSCode configuration
âââ migrations                      # Database migrations
âââ public                          # Public assets folder
âââ scripts                         # Scripts folder
âââ src
â   âââ app                         # Next JS App (App Router)
â   âââ components                  # Reusable components
â   âââ features                    # Components specific to a feature
â   âââ libs                        # 3rd party libraries configuration
â   âââ locales                     # Locales folder (i18n messages)
â   âââ models                      # Database models
â   âââ styles                      # Styles folder
â   âââ templates                   # Templates folder
â   âââ types                       # Type definitions
â   âââ utils                       # Utilities folder
âââ tests
â   âââ e2e                         # E2E tests, also includes Monitoring as Code
âââ tailwind.config.js              # Tailwind CSS configuration
âââ tsconfig.json                   # TypeScript configuration

Customization

You can easily configure Next.js SaaS Boilerplate by making a search in the whole project with FIXME: for making quick customization. Here is some of the most important files to customize:

public/apple-touch-icon.png, public/favicon.ico, public/favicon-16x16.png and public/favicon-32x32.png: your website favicon, you can generate from https://favicon.io/favicon-converter/
src/utils/AppConfig.ts: configuration file
src/templates/BaseTemplate.tsx: default theme
next.config.mjs: Next.js configuration
.env: default environment variables

You have access to the whole code source if you need further customization. The provided code is only example for you to start your project. The sky is the limit ð.

Commit Message Format

The project enforces Conventional Commits specification. This means that all your commit messages must be formatted according to the specification. To help you write commit messages, the project uses Commitizen, an interactive CLI that guides you through the commit process. To use it, run the following command:

npm run commit

One of the benefits of using Conventional Commits is that it allows us to automatically generate a CHANGELOG file. It also allows us to automatically determine the next version number based on the types of commits that are included in a release.

Testing

All unit tests are located with the source code inside the same directory. So, it makes it easier to find them. The project uses Vitest and React Testing Library for unit testing. You can run the tests with:

npm run test

Integration & E2E Testing

The project uses Playwright for Integration and E2E testing. You can run the tests with:

npx playwright install # Only for the first time in a new environment
npm run test:e2e

Enable Edge runtime (optional)

The App Router folder is compatible with the Edge runtime. You can enable it by adding the following lines src/app/layouts.tsx:

export const runtime = 'edge';

For your information, the database migration is not compatible with the Edge runtime. So, you need to disable the automatic migration in src/libs/DB.ts:

await migrate(db, { migrationsFolder: './migrations' });

After disabling it, you are required to run the migration manually with:

npm run db:migrate

You also require to run the command each time you want to update the database schema.

Deploy to production

During the build process, the database migration is automatically executed. So, you don't need to run the migration manually. But, in your environment variable, DATABASE_URL need to be defined.

Then, you can generate a production build with:

$ npm run build

It generates an optimized production build of the boilerplate. For testing the generated build, you can run:

$ npm run start

You also need to defined the environment variables CLERK_SECRET_KEY using your own key.

The command starts a local server with the production build. Then, you can now open http://localhost:3000 with your favorite browser to see the project.

Error Monitoring

The project uses Sentry to monitor errors. For development environment, you don't need to do anything: NextJS SaaS Boilerplate is already configured to use Sentry and Spotlight (Sentry for Development). All errors will be automatically sent to your local Spotlight instance. So, you can try the Sentry experience locally.

For production environment, you need to create a Sentry account and create a new project. Then, in next.config.mjs, you need to update the org and project attribute in withSentryConfig function. You also need to add your Sentry DSN in sentry.client.config.ts, sentry.edge.config.ts and sentry.server.config.ts.

Code coverage

NextJS Boilerplate relies on Codecov for code coverage reporting solution. To use Codecov, create a Codecov account and connect it to your GitHub account. On your Codecov dashboard, it should display a list of your repositories. Select the repository you want to enable Codecov for and copy the token. Then, in your GitHub Actions, you need to define the CODECOV_TOKEN environment variable and paste the token you copied.

Be sure to create the CODECOV_TOKEN as a Github Actions secret, do not paste it directly into your source code.

Logging

The project uses Pino.js for logging. By default, for development environment, the logs are displayed in the console.

For production environment, the project is already integrated with Better Stack to manage and query your logs using SQL. To use Better Stack, you need to create a Better Stack account and create a new source: go to your Better Stack Logs Dashboard > Sources > Connect source. Then, you need to give a name to your source and select Node.js as the platform.

After creating the source, you able to see your source token and copy it. Then, in your environment variabless, you can paste the token in LOGTAIL_SOURCE_TOKEN variable. Now, all your logs will be automatically sent and ingested by Better Stack.

Checkly monitoring

The project uses Checkly to ensure that your production environment is always up and running. At regular intervals, Checkly runs the tests ending with *.check.spec.ts extension and notifies you if any of the tests fail. Additionally, you have the flexibility to execute tests across multiple locations to ensure that your application is available worldwide.

To use Checkly, you must first create an account on their website. Once you have an account, you can set the CHECKLY_API_KEY environment variable in GitHub Actions by generating a new API key in the Checkly Dashboard. Additionally, you will need to define the CHECKLY_ACCOUNT_ID, which can also be found in your Checkly Dashboard under User Settings > General.

To complete the setup, make sure to update the checkly.config.ts file with your own email address and production URL.

Useful commands

Bundle Analyzer

SaaS Boilerplate comes with a built-in bundle analyzer. It can be used to analyze the size of your JavaScript bundles. To begin, run the following command:

npm run build-stats

By running the command, it'll automatically open a new browser window with the results.

Database Studio

The project is already configured with Drizzle Studio to explore the database. You can run the following command to open the database studio:

npm run db:studio

Then, you can open https://local.drizzle.studio with your favorite browser to explore your database.

VSCode information (optional)

If you are VSCode users, you can have a better integration with VSCode by installing the suggested extension in .vscode/extension.json. The starter code comes up with Settings for a seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience.

With the plugins installed on your VSCode, ESLint and Prettier can automatically fix the code and show you the errors. Same goes for testing, you can install VSCode Vitest extension to automatically run your tests and it also show the code coverage in context.

Pro tips: if you need a project wide type checking with TypeScript, you can run a build with Cmd + Shift + B on Mac.

Contributions

Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug. Totally open to any suggestions and improvements.

License

See LICENSE for more information.

Top Related Projects

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot