Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/boxyhq/saas-starter-kit

🔥 Enterprise SaaS Starter Kit - Kickstart your enterprise app development with the Next.js SaaS boilerplate 🚀
https://github.com/boxyhq/saas-starter-kit

boilerplate boilerplates hacktoberfest js-boilerplate next-auth nextjs nodejs react saas saas-app saas-application saas-boilerplate saas-kit starter-kit starter-template tailwindcss typescript

Last synced: 15 days ago
JSON representation

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

Lists

README 

        

  

  

  BoxyHQ Banner



# ⭐ Enterprise SaaS Starter Kit





    Github stargazers

    Github issues

    license

    Twitter

    LinkedIn

    Discord




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! 😀



## 📖 Additional Resources



Video - [BoxyHQ's SaaS Starter Kit: Your Ultimate Enterprise-Compliant Boilerplate](https://www.youtube.com/watch?v=oF8QIwQIhyo) 


Blog - [Enterprise-ready Saas Starter Kit](https://boxyhq.com/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.



## 🛠️ Built With



- [Next.js](https://nextjs.org)

  This 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 in next.config.js.

- [Tailwind CSS](https://tailwindcss.com)

  This 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 in postcss.config.js.

- [Postgres](https://www.postgresql.org)

  This 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.

- [React](https://reactjs.org)

  This 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.

- [Prisma](https://www.prisma.io)

  This 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.

- [TypeScript](https://www.typescriptlang.org)

  This 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 like next-env.d.ts and i18next.d.ts.

- [SAML Jackson](https://github.com/boxyhq/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](https://www.svix.com/) (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](https://github.com/retracedhq/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](https://stripe.com) (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](https://playwright.dev) (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](https://www.docker.com) (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](https://next-auth.js.org) (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 the pages/api/auth/[...nextauth].ts file.



## 🚀 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: >=18.x)

- PostgreSQL

- NPM

- Docker compose



### Development



#### 1. Setup



- [Fork](https://github.com/boxyhq/saas-starter-kit/fork) the repository

- Clone the repository by using this command:



```bash

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

```



#### 2. Go to the project folder



```bash

cd saas-starter-kit

```



#### 3. Install dependencies



```bash

npm install

```



#### 4. Set up your .env file



Duplicate `.env.example` to `.env`.



```bash

cp .env.example .env

```



#### 5. Create a database (Optional)



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



```bash

docker-compose up -d

```



#### 6. Set up database schema



```bash

npx prisma db push

```



#### 7. Start the server



In a development environment:



```bash

npm run dev

```



#### 8. Start the Prisma Studio



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



```bash

npx prisma studio

```



#### 9. Testing



We are using [Playwright](https://playwright.dev/) to execute E2E tests. Add all tests inside the `/tests` folder.



Update `playwright.config.ts` to change the playwright configuration.



##### Install Playwright dependencies



```bash

npm run playwright:update

```



##### Run E2E tests



```bash

npm run test:e2e

```



_Note: HTML test report is generated inside the `report` folder. Currently supported browsers for test execution `chromium` and `firefox`_



#### Fully customizable boilerplate out of the box, see images below 👇👇👇



![saas-starter-kit-poster](/public/saas-starter-kit-poster.png)



## 🥇 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](https://support.google.com/cloud/answer/6158849?hl=en)]

- Sign in with GitHub [[Creating a Github OAuth App](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-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



## ➡️ Coming Soon



- Billing & subscriptions

- Unit and integration tests



## ✨ 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](https://github.com/boxyhq/saas-starter-kit/blob/main/CONTRIBUTING.md)



## 🤩 Community



- [Discord](https://discord.gg/uyb7pYt4Pa) (For live discussion with the Open-Source Community and BoxyHQ team)

- [Twitter](https://twitter.com/BoxyHQ) / [LinkedIn](https://www.linkedin.com/company/boxyhq) (Follow us)

- [Youtube](https://www.youtube.com/@boxyhq) (Watch community events and tutorials)

- [GitHub Issues](https://github.com/boxyhq/saas-starter-kit/issues) (Contributions, report issues, and product ideas)



## 🌍 Contributors





  




Made with [contrib.rocks](https://contrib.rocks).



## 🛡️ License



[Apache 2.0 License](https://github.com/boxyhq/saas-starter-kit/blob/main/LICENSE)