SaaS Starter Kit

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

Next.jsBoilerplateReactAuthentication / Authorization
boxyhq/saas-starter-kitboxyhq.com/blog/enterprise-ready-saas-starter-kit

README

Enterprise SaaS Starter Kit


:warning: This repository is still in an early stage of development.

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

Next.js based SaaS starter kit that 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.

Built With


- Next.js
- Tailwind CSS
- Postgres
- React
- Prisma
- TypeScript
- SAML Jackson (Provides SAML SSO, Directory Sync)
- Svix (Provides Webhook Orchestration)

Deployment


Deploy with Vercel

Deploy to Heroku

Deploy to DO

Getting Started


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

Prerequisites


- Node.js (Version: >=15.x <17)
- PostgreSQL
- NPM
- Docker compose

Development


1. Setup


Clone or fork this GitHub repository

  1. ```bash
  2. git clone https://github.com/boxyhq/saas-starter-kit.git
  3. ```

2. Go to the project folder


  1. ```bash
  2. cd saas-starter-kit
  3. ```

3. Install dependencies


  1. ```bash
  2. npm install
  3. ```

4. Set up your .env file


Duplicate .env.example to .env.

  1. ```bash
  2. cp .env.example .env
  3. ```

5. Create database (Optional)


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

  1. ```bash
  2. docker-compose up -d
  3. ```

6. Set up database schema


  1. ```bash
  2. npx prisma db push
  3. ```

7. Start the server


In a development environment:

  1. ```bash
  2. npm run dev
  3. ```

8. Start the Prisma Studio


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

  1. ```bash
  2. npx prisma studio
  3. ```

8. Testing


We are using Playwright to execute E2E tests. Add all tests inside/tests folder.

Update playwright.config.ts to change playwright configuration.

Install Playwright dependencies

  1. ```bash
  2. npm run playwright:update
  3. ```

Run E2E tests

  1. ```bash
  2. npm run test:e2e
  3. ```

_Note: HTML test report is generated inside the report folder. Currently suported browsers for test execution chromium and firefox_

Features


- 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
- Invite users to the team
- Manage team members
- Update team settings
- Webhooks & Events
- Internationalization

Coming Soon


- Audit logs
- Unit and integration tests
- Dark mode
- Mobile-first UI
- Billing & subscriptions
- Roles and Permissions

Contributing


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

Community


- Discord (For live discussion with the Community and BoxyHQ team)
- Twitter (Get the news fast)
- GitHub Issues (Bug reports, Contributions)

License


Apache 2.0 License