Participating in
⬆️ Take a look at our Issues ⬆️
⭐ Enterprise SaaS Starter Kit
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
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
- Tailwind CSS
- Postgres
- React
- Prisma
- TypeScript
- SAML Jackson (Provides SAML SSO, Directory Sync)
- Svix (Provides Webhook Orchestration)
- Retraced (Provides Audit Logs Service)
🚀 Deployment
✨ 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
Clone or fork this GitHub repository
git clone https://github.com/boxyhq/saas-starter-kit.git
2. Go to the project folder
cd saas-starter-kit
3. Install dependencies
npm install
4. Set up your .env file
Duplicate .env.example
to .env
.
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.
docker-compose up -d
6. Set up database schema
npx prisma db push
7. Start the server
In a development environment:
npm run dev
8. Start the Prisma Studio
Prisma Studio is a visual editor for the data in your database.
npx prisma studio
8. Testing
We are using Playwright to execute E2E tests. Add all tests inside the /tests
folder.
Update playwright.config.ts
to change the playwright configuration.
Install Playwright dependencies
npm run playwright:update
Run E2E tests
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 👇👇👇
🥇 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
- Audit logs
- Roles and Permissions
- Dark mode
➡️ 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.
🤩 Community
- 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)