Repository files navigation

The Open Source Next.js SaaS boilerplate for Enterprise SaaS app development.

Please star ⭐ the repo if you want us to continue developing and improving the SaaS Starter Kit! 😀

Video -BoxyHQ's SaaS Starter Kit: Your Ultimate Enterprise-Compliant Boilerplate
Blog -Enterprise-ready Saas Starter Kit

Next.js-based SaaS starter kit saves you months of development by starting you off with all the features that are the same in every product, so you can focus on what makes your app unique.

• Next.jsThis is a React framework that provides features such as server-side rendering and static site generation. It's used for building the user interface of your application. The main configuration for Next.js can be found innext.config.js.
• Tailwind CSSThis is a utility-first CSS framework for rapidly building custom user interfaces. It's used for styling the application. The configuration for Tailwind CSS can be found inpostcss.config.js.
• PostgresThis is a powerful, open source object-relational database system. It's used for storing application data. The connection to Postgres is likely managed through Prisma.
• ReactThis is a JavaScript library for building user interfaces. It's used for creating the interactive elements of your application. The React components are located in the components directory.
• PrismaThis is an open-source database toolkit. It's used for object-relational mapping, which simplifies the process of writing database queries. Prisma configuration and schema can be found in the prisma directory.
• TypeScriptThis is a typed superset of JavaScript that compiles to plain JavaScript. It's used to make the code more robust and maintainable. TypeScript definitions and configurations can be found in files likenext-env.d.ts andi18next.d.ts.
• SAML Jackson (Provides SAML SSO, Directory Sync)This is a service for handling SAML SSO (Single Sign-On). It's used to allow users to sign in with a single ID and password to any of several related systems i.e (using a single set of credentials). The implementation of SAML Jackson is primarily located within the files associated with authentication.
• Svix (Provides Webhook Orchestration)This is a service for handling webhooks. It's used to emit events on user/team CRUD operations, which can then be caught and handled by other parts of the application or external services. The integration of Svix is distributed throughout the codebase, primarily in areas where Create, Read, Update, and Delete (CRUD) operations are executed.
• Retraced (Provides Audit Logs Service)This is a service for audit logging and data visibility. It helps track user activities within the application i.e (who did what and when in the application). The usage of Retraced would be dispersed throughout the codebase, likely in the files where important actions are performed.
• Stripe (Provides Payments)This is a service for handling payments. It's used to process payments for the application. The integration of Stripe is likely found in the files associated with billing and subscriptions.
• Playwright (Provides E2E tests)This is a Node.js library for automating browsers. It's used to run end-to-end tests on the application. The Playwright configuration and tests can be found in the tests directory.
• Docker (Provides Docker Compose)This is a platform for developing, shipping, and running applications. It's used to containerize the application and its dependencies. The Docker configuration can be found in the Dockerfile and docker-compose.yml.
• NextAuth.js (Provides Authentication)This is a complete open-source authentication solution for Next.js applications. It's used to handle user authentication and authorization. The NextAuth.js configuration and providers can be found in thepages/api/auth/[...nextauth].ts file.

Please follow these simple steps to get a local copy up and running.

• Node.js (Version: >=18.x)
• PostgreSQL
• NPM
• Docker compose

• Fork the repository
• Clone the repository by using this command:

git clone https://github.com/<your_github_username>/saas-starter-kit.git

cd saas-starter-kit

npm install

Duplicate.env.example to.env.

cp .env.example .env

To make the process of installing dependencies easier, we offer adocker-compose.yml with a Postgres container.

docker-compose up -d

npx prisma db push

In a development environment:

npm run dev

Prisma Studio is a visual editor for the data in your database.

npx prisma studio

We are usingPlaywright to execute E2E tests. Add all tests inside the/tests folder.

Updateplaywright.config.ts to change the playwright configuration.

npm run playwright:update

npm run test:e2e

Note: HTML test report is generated inside thereport folder. Currently supported browsers for test executionchromium andfirefox

To get started you only need to configure the database by following the steps above. For more advanced features, you can configure the following:

The default login options are email and GitHub. Configure below:

1. Generate a secret key for NextAuth.js by runningopenssl rand -base64 32 and adding it to the.env file asNEXTAUTH_SECRET.
2. For email login, configure theSMTP_* environment variables in the.env file to send magic link login emails. You can use services likeAWS SES,Sendgrid orResend.
3. For social login with GitHub and Google, you need to create OAuth apps in the respective developer consoles and add the client ID and secret to the.env file. The default is email login and For GitHub, follow the instructionshere. For Google, follow the instructionshere.

1. Create an account onSvix
2. The authenticaton token and addSVIX_API_KEY to the.env file.

1. Create an account onStripe
2. Add theStripe API secret key to the.env file asSTRIPE_SECRET_KEY.
3. Create a webhook in theStripe dashboard. The URL is your app hostname plus/api/webhooks/stripe. If you want to set this up locally you will need to use theStripe CLI forwarder.
4. Once created, add the signing secret to the.env file asSTRIPE_WEBHOOK_SECRET.

1. Create an account onGoogle reCAPTCHA. This will create a Google Cloud account if you don't have one.
2. From the Key Details in theGoogle Cloud Console, add the reCAPTCHA ID to the.env file asRECAPTCHA_SITE_KEY.
3. Click Key Details > Integration then click Use legacy key to get the secret key and add it to the.env file asRECAPTCHA_SECRET_KEY.

1. Create an account onSentry, skip the onboarding and create a new Next.js project.
2. At the bottom of the page, get the DSN and add it to the.env file asSENTRY_DSN. The other variables are optional.

• Create account
• Sign in with Email and Password
• Sign in with Magic Link
• Sign in with SAML SSO
• Sign in with Google [Setting up Google OAuth]
• Sign in with GitHub [Creating a Github OAuth App]
• Directory Sync (SCIM)
• Update account
• Create team
• Delete team
• Invite users to the team
• Manage team members
• Update team settings
• Webhooks & Events
• Internationalization
• Audit logs
• Roles and Permissions
• Dark mode
• Email notifications
• E2E tests
• Docker compose
• Prisma Studio
• Update member role
• Directory Sync Events
• Avatar Upload
• SAML SSO
• Audit Log
• Webhook
• Payments
• Security Headers

• Billing & subscriptions
• Unit and integration tests

Thanks for taking the time to contribute! Contributions make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

Contributing Guide

• Discord (For live discussion with the Open-Source Community and BoxyHQ team)
• Twitter /LinkedIn (Follow us)
• Youtube (Watch community events and tutorials)
• GitHub Issues (Contributions, report issues, and product ideas)

Made withcontrib.rocks.

Apache 2.0 License