bradduy commited on
Commit
cbf9880
·
1 Parent(s): f7dc5bc
Files changed (1) hide show
  1. README.md +6 -522
README.md CHANGED
@@ -1,522 +1,6 @@
1
- # Boilerplate and Starter for Next.js 15+, Tailwind CSS 3.4, and TypeScript.
2
-
3
- <p align="center">
4
- <a href="https://demo.nextjs-boilerplate.com"><img height="300" src="public/assets/images/nextjs-starter-banner.png?raw=true" alt="Next js starter banner"></a>
5
- </p>
6
-
7
- 🚀 Boilerplate and Starter for Next.js with App Router, Tailwind CSS, and TypeScript ⚡️ Prioritizing developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Vitest (replacing Jest), Testing Library, Playwright, Commitlint, VSCode, Tailwind CSS, Authentication with [Clerk](https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate), Database with DrizzleORM (PostgreSQL, SQLite, and MySQL), Error Monitoring with [Sentry](https://sentry.io/for/nextjs/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo), Logging with Pino.js and Log Management, Monitoring as Code, Storybook, Multi-language (i18n), Secure with [Arcjet](https://launch.arcjet.com/Q6eLbRE) (Bot detection, Rate limiting, Attack protection, etc.) and more.
8
-
9
- Clone this project and use it to create your own Next.js project. You can check out the live demo at [Next.js Boilerplate](https://demo.nextjs-boilerplate.com), which includes a working authentication system.
10
-
11
- ## Sponsors
12
-
13
- <table width="100%">
14
- <tr height="187px">
15
- <td align="center" width="33%">
16
- <a href="https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate">
17
- <picture>
18
- <source media="(prefers-color-scheme: dark)" srcset="https://github.com/ixartz/SaaS-Boilerplate/assets/1328388/6fb61971-3bf1-4580-98a0-10bd3f1040a2">
19
- <source media="(prefers-color-scheme: light)" srcset="https://github.com/ixartz/SaaS-Boilerplate/assets/1328388/f80a8bb5-66da-4772-ad36-5fabc5b02c60">
20
- <img alt="Clerk – Authentication & User Management for Next.js" src="https://github.com/ixartz/SaaS-Boilerplate/assets/1328388/f80a8bb5-66da-4772-ad36-5fabc5b02c60">
21
- </picture>
22
- </a>
23
- </td>
24
- <td align="center" width="33%">
25
- <a href="https://l.crowdin.com/next-js">
26
- <picture>
27
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/crowdin-white.png?raw=true">
28
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/crowdin-dark.png?raw=true">
29
- <img alt="Crowdin" src="public/assets/images/crowdin-dark.png?raw=true">
30
- </picture>
31
- </a>
32
- </td>
33
- <td align="center" width="33%">
34
- <a href="https://sentry.io/for/nextjs/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo">
35
- <picture>
36
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/sentry-white.png?raw=true">
37
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/sentry-dark.png?raw=true">
38
- <img alt="Sentry" src="public/assets/images/sentry-dark.png?raw=true">
39
- </picture>
40
- </a>
41
- <a href="https://about.codecov.io/codecov-free-trial/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo">
42
- <picture>
43
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/codecov-white.svg?raw=true">
44
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/codecov-dark.svg?raw=true">
45
- <img alt="Codecov" src="public/assets/images/codecov-dark.svg?raw=true">
46
- </picture>
47
- </a>
48
- </td>
49
- </tr>
50
- <tr height="187px">
51
- <td align="center" width="33%">
52
- <a href="https://launch.arcjet.com/Q6eLbRE">
53
- <picture>
54
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/arcjet-dark.svg?raw=true">
55
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/arcjet-light.svg?raw=true">
56
- <img alt="Arcjet" src="public/assets/images/arcjet-light.svg?raw=true">
57
- </picture>
58
- </a>
59
- </td>
60
- <td align="center" width="33%">
61
- <a href="https://posthog.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
62
- <picture>
63
- <source media="(prefers-color-scheme: dark)" srcset="https://posthog.com/brand/posthog-logo-white.svg">
64
- <source media="(prefers-color-scheme: light)" srcset="https://posthog.com/brand/posthog-logo.svg">
65
- <img alt="PostHog" src="https://posthog.com/brand/posthog-logo.svg">
66
- </picture>
67
- </a>
68
- </td>
69
- <td align="center" width="33%">
70
- <a href="https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
71
- <picture>
72
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/better-stack-white.png?raw=true">
73
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/better-stack-dark.png?raw=true">
74
- <img alt="Better Stack" src="public/assets/images/better-stack-dark.png?raw=true">
75
- </picture>
76
- </a>
77
- </td>
78
- </tr>
79
- <tr height="187px">
80
- <td align="center" width="33%">
81
- <a href="https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
82
- <picture>
83
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/checkly-logo-dark.png?raw=true">
84
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/checkly-logo-light.png?raw=true">
85
- <img alt="Checkly" src="public/assets/images/checkly-logo-light.png?raw=true">
86
- </picture>
87
- </a>
88
- </td>
89
- <td align="center" style=width="33%">
90
- <a href="https://nextjs-boilerplate.com/pro-saas-starter-kit">
91
- <img src="public/assets/images/nextjs-boilerplate-saas.png?raw=true" alt="Next.js SaaS Boilerplate with React" />
92
- </a>
93
- </td>
94
- </tr>
95
- <tr height="187px">
96
- <td align="center" width="33%">
97
- <a href="mailto:[email protected]">
98
- Add your logo here
99
- </a>
100
- </td>
101
- </tr>
102
- </table>
103
-
104
- ### Demo
105
-
106
- **Live demo: [Next.js Boilerplate](https://demo.nextjs-boilerplate.com)**
107
-
108
- | Sign Up | Sign In |
109
- | --- | --- |
110
- | [![Next.js Boilerplate SaaS Sign Up](public/assets/images/nextjs-boilerplate-sign-in.png)](https://demo.nextjs-boilerplate.com/sign-up) | [![Next.js Boilerplate SaaS Sign In](public/assets/images/nextjs-boilerplate-sign-in.png)](https://demo.nextjs-boilerplate.com/sign-in) |
111
-
112
- ### Features
113
-
114
- Developer experience first, extremely flexible code structure and only keep what you need:
115
-
116
- - ⚡ [Next.js](https://nextjs.org) with App Router support
117
- - 🔥 Type checking [TypeScript](https://www.typescriptlang.org)
118
- - 💎 Integrate with [Tailwind CSS](https://tailwindcss.com)
119
- - ✅ Strict Mode for TypeScript and React 19
120
- - 🔒 Authentication with [Clerk](https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate): Sign up, Sign in, Sign out, Forgot password, Reset password, and more.
121
- - 👤 Passwordless Authentication with Magic Links, Multi-Factor Auth (MFA), Social Auth (Google, Facebook, Twitter, GitHub, Apple, and more), Passwordless login with Passkeys, User Impersonation
122
- - 📦 Type-safe ORM with DrizzleORM, compatible with PostgreSQL, SQLite, and MySQL
123
- - 💽 Offline and local development database with PGlite
124
- - 🌐 Multi-language (i18n) with [next-intl](https://next-intl-docs.vercel.app/) and [Crowdin](https://l.crowdin.com/next-js)
125
- - ♻️ Type-safe environment variables with T3 Env
126
- - ⌨️ Form handling with React Hook Form
127
- - 🔴 Validation library with Zod
128
- - 📏 Linter with [ESLint](https://eslint.org) (default Next.js, Next.js Core Web Vitals, Tailwind CSS and Antfu configuration)
129
- - 💖 Code Formatter with [Prettier](https://prettier.io)
130
- - 🦊 Husky for Git Hooks
131
- - 🚫 Lint-staged for running linters on Git staged files
132
- - 🚓 Lint git commit with Commitlint
133
- - 📓 Write standard compliant commit messages with Commitizen
134
- - 🦺 Unit Testing with Vitest and React Testing Library
135
- - 🧪 Integration and E2E Testing with Playwright
136
- - 👷 Run tests on pull request with GitHub Actions
137
- - 🎉 Storybook for UI development
138
- - 🚨 Error Monitoring with [Sentry](https://sentry.io/for/nextjs/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo)
139
- - ☂️ Code coverage with [Codecov](https://about.codecov.io/codecov-free-trial/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo)
140
- - 📝 Logging with Pino.js and Log Management with [Better Stack](https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate)
141
- - 🖥️ Monitoring as Code with [Checkly](https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate)
142
- - 🔐 Security and bot protection ([Arcjet](https://launch.arcjet.com/Q6eLbRE))
143
- - 🎁 Automatic changelog generation with Semantic Release
144
- - 🔍 Visual testing with Percy (Optional)
145
- - 💡 Absolute Imports using `@` prefix
146
- - 🗂 VSCode configuration: Debug, Settings, Tasks and Extensions
147
- - 🤖 SEO metadata, JSON-LD and Open Graph tags
148
- - 🗺️ Sitemap.xml and robots.txt
149
- - ⌘ Database exploration with Drizzle Studio and CLI migration tool with Drizzle Kit
150
- - ⚙️ [Bundler Analyzer](https://www.npmjs.com/package/@next/bundle-analyzer)
151
- - 🌈 Include a FREE minimalist theme
152
- - 💯 Maximize lighthouse score
153
-
154
- Built-in feature from Next.js:
155
-
156
- - ☕ Minify HTML & CSS
157
- - 💨 Live reload
158
- - ✅ Cache busting
159
-
160
- ### Philosophy
161
-
162
- - Nothing is hidden from you, allowing you to make any necessary adjustments to suit your requirements and preferences.
163
- - Dependencies are regularly updated on a monthly basis
164
- - Start for free without upfront costs
165
- - Easy to customize
166
- - Minimal code
167
- - Unstyled template
168
- - SEO-friendly
169
- - 🚀 Production-ready
170
-
171
- ### Requirements
172
-
173
- - Node.js 20+ and npm
174
-
175
- ### Getting started
176
-
177
- Run the following command on your local environment:
178
-
179
- ```shell
180
- git clone --depth=1 https://github.com/ixartz/Next-js-Boilerplate.git my-project-name
181
- cd my-project-name
182
- npm install
183
- ```
184
-
185
- For your information, all dependencies are updated every month.
186
-
187
- Then, you can run the project locally in development mode with live reload by executing:
188
-
189
- ```shell
190
- npm run dev
191
- ```
192
-
193
- Open http://localhost:3000 with your favorite browser to see your project.
194
-
195
- ### Set up authentication
196
-
197
- To get started, you will need to create a Clerk account at [Clerk.com](https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate) and create a new application in the Clerk Dashboard. Once you have done that, copy the `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` and `CLERK_SECRET_KEY` values and add them to the `.env.local` file (not tracked by Git):
198
-
199
- ```shell
200
- NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_pub_key
201
- CLERK_SECRET_KEY=your_clerk_secret_key
202
- ```
203
-
204
- Now you have a fully functional authentication system with Next.js, including features such as sign up, sign in, sign out, forgot password, reset password, update profile, update password, update email, delete account, and more.
205
-
206
- ### Set up remote database
207
-
208
- The project uses DrizzleORM, a type-safe ORM that is compatible with PostgreSQL, SQLite, and MySQL databases. By default, the project is configured to seamlessly work with PostgreSQL, and you have the flexibility to choose any PostgreSQL database provider of your choice.
209
-
210
- ### Translation (i18n) setup
211
-
212
- For translation, the project uses `next-intl` combined with [Crowdin](https://l.crowdin.com/next-js). As a developer, you only need to take care of the English (or another default language) version. Translations for 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.
213
-
214
- To set up translation (i18n), create an account at [Crowdin.com](https://l.crowdin.com/next-js) and create a new project. In the newly created project, you will be able to find the project ID. You will also need to create a new Personal Access Token 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`.
215
-
216
- After defining the environment variables in your GitHub Actions, your localization files will be synchronized with Crowdin every time you push a new commit to the `main` branch.
217
-
218
- ### Project structure
219
-
220
- ```shell
221
- .
222
- ├── README.md # README file
223
- ├── .github # GitHub folder
224
- ├── .husky # Husky configuration
225
- ├── .storybook # Storybook folder
226
- ├── .vscode # VSCode configuration
227
- ├── migrations # Database migrations
228
- ├── public # Public assets folder
229
- ├── src
230
- │ ├── app # Next JS App (App Router)
231
- │ ├── components # React components
232
- │ ├── libs # 3rd party libraries configuration
233
- │ ├── locales # Locales folder (i18n messages)
234
- │ ├── models # Database models
235
- │ ├── styles # Styles folder
236
- │ ├── templates # Templates folder
237
- │ ├── types # Type definitions
238
- │ ├── utils # Utilities folder
239
- │ └── validations # Validation schemas
240
- ├── tests
241
- │ ├── e2e # E2E tests, also includes Monitoring as Code
242
- │ └── integration # Integration tests
243
- ├── tailwind.config.js # Tailwind CSS configuration
244
- └── tsconfig.json # TypeScript configuration
245
- ```
246
-
247
- ### Customization
248
-
249
- You can easily configure Next js Boilerplate by searching the entire project for `FIXME:` to make quick customizations. Here are some of the most important files to customize:
250
-
251
- - `public/apple-touch-icon.png`, `public/favicon.ico`, `public/favicon-16x16.png` and `public/favicon-32x32.png`: your website favicon
252
- - `src/utils/AppConfig.ts`: configuration file
253
- - `src/templates/BaseTemplate.tsx`: default theme
254
- - `next.config.mjs`: Next.js configuration
255
- - `.env`: default environment variables
256
-
257
- You have full access to the source code for further customization. The provided code is just an example to help you start your project. The sky's the limit 🚀.
258
-
259
- ### Change database schema
260
-
261
- To modify the database schema in the project, you can update the schema file located at `./src/models/Schema.ts`. This file defines the structure of your database tables using the Drizzle ORM library.
262
-
263
- After making changes to the schema, generate a migration by running the following command:
264
-
265
- ```shell
266
- npm run db:generate
267
- ```
268
-
269
- This will create a migration file that reflects your schema changes. The migration is automatically applied during the next database interaction, so there is no need to run it manually or restart the Next.js server.
270
-
271
- ### Commit Message Format
272
-
273
- The project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification, meaning all commit messages must be formatted accordingly. To help you write commit messages, the project uses [Commitizen](https://github.com/commitizen/cz-cli), an interactive CLI that guides you through the commit process. To use it, run the following command:
274
-
275
- ```shell
276
- npm run commit
277
- ```
278
-
279
- One of the benefits of using Conventional Commits is the ability 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.
280
-
281
- ### Testing
282
-
283
- All unit tests are located alongside the source code in the same directory, making them easier to find. The project uses Vitest and React Testing Library for unit testing. You can run the tests with the following command:
284
-
285
- ```shell
286
- npm run test
287
- ```
288
-
289
- ### Integration & E2E Testing
290
-
291
- The project uses Playwright for integration and end-to-end (E2E) testing. You can run the tests with the following commands:
292
-
293
- ```shell
294
- npx playwright install # Only for the first time in a new environment
295
- npm run test:e2e
296
- ```
297
-
298
- In the local environment, visual testing is disabled, and the terminal will display the message `[percy] Percy is not running, disabling snapshots.`. By default, visual testing only runs in GitHub Actions.
299
-
300
- ### Enable Edge runtime (optional)
301
-
302
- The App Router folder is compatible with the Edge runtime. You can enable it by adding the following lines `src/app/layouts.tsx`:
303
-
304
- ```tsx
305
- export const runtime = 'edge';
306
- ```
307
-
308
- 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`:
309
-
310
- ```tsx
311
- await migrate(db, { migrationsFolder: './migrations' });
312
- ```
313
-
314
- After disabling it, you are required to run the migration manually with:
315
-
316
- ```shell
317
- npm run db:migrate
318
- ```
319
-
320
- You also require to run the command each time you want to update the database schema.
321
-
322
- ### Deploy to production
323
-
324
- During the build process, database migrations are automatically executed, so there's no need to run them manually. However, you must define `DATABASE_URL` in your environment variables.
325
-
326
- Then, you can generate a production build with:
327
-
328
- ```shell
329
- $ npm run build
330
- ```
331
-
332
- It generates an optimized production build of the boilerplate. To test the generated build, run:
333
-
334
- ```shell
335
- $ npm run start
336
- ```
337
-
338
- You also need to defined the environment variables `CLERK_SECRET_KEY` using your own key.
339
-
340
- This command starts a local server using the production build. You can now open http://localhost:3000 in your preferred browser to see the result.
341
-
342
- ### Error Monitoring
343
-
344
- The project uses [Sentry](https://sentry.io/for/nextjs/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo) to monitor errors. In the development environment, no additional setup is needed: Next.js Boilerplate is pre-configured to use Sentry and Spotlight (Sentry for Development). All errors will automatically be sent to your local Spotlight instance, allowing you to experience Sentry locally.
345
-
346
- For production environment, you'll need to create a Sentry account and a new project. Then, in `next.config.mjs`, you need to update the `org` and `project` attributes in `withSentryConfig` function. Additionally, add your Sentry DSN to `sentry.client.config.ts`, `sentry.edge.config.ts` and `sentry.server.config.ts`.
347
-
348
- ### Code coverage
349
-
350
- Next.js Boilerplate relies on [Codecov](https://about.codecov.io/codecov-free-trial/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo) for code coverage reporting solution. To enable Codecov, create a Codecov account and connect it to your GitHub account. Your repositories should appear on your Codecov dashboard. Select the desired repository and copy the token. In GitHub Actions, define the `CODECOV_TOKEN` environment variable and paste the token.
351
-
352
- Make sure to create `CODECOV_TOKEN` as a GitHub Actions secret, do not paste it directly into your source code.
353
-
354
- ### Logging
355
-
356
- The project uses Pino.js for logging. In the development environment, logs are displayed in the console by default.
357
-
358
- For production, the project is already integrated with [Better Stack](https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate) to manage and query your logs using SQL. To use Better Stack, you need to create a [Better Stack](https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate) 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.
359
-
360
- After creating the source, you will be able to view and copy your source token. In your environment variables, paste the token into the `LOGTAIL_SOURCE_TOKEN` variable. Now, all logs will automatically be sent to and ingested by Better Stack.
361
-
362
- ### Checkly monitoring
363
-
364
- The project uses [Checkly](https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate) to ensure that your production environment is always up and running. At regular intervals, Checkly runs the tests ending with `*.check.e2e.ts` extension and notifies you if any of the tests fail. Additionally, you have the flexibility to execute tests from multiple locations to ensure that your application is available worldwide.
365
-
366
- To use Checkly, you must first create an account on [their website](https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate). After creating an account, generate a new API key in the Checkly Dashboard and set the `CHECKLY_API_KEY` environment variable in GitHub Actions. Additionally, you will need to define the `CHECKLY_ACCOUNT_ID`, which can also be found in your Checkly Dashboard under User Settings > General.
367
-
368
- To complete the setup, update the `checkly.config.ts` file with your own email address and production URL.
369
-
370
- ### Arcjet security and bot protection
371
-
372
- The project uses [Arcjet](https://launch.arcjet.com/Q6eLbRE), a security as code product that includes several features that can be used individually or combined to provide defense in depth for your site.
373
-
374
- To set up Arcjet, [create a free account](https://launch.arcjet.com/Q6eLbRE) and get your API key. Then add it to the `ARCJET_KEY` environment variable.
375
-
376
- Arcjet is configured with two main features: bot detection and the Arcjet Shield WAF:
377
-
378
- - [Bot detection](https://docs.arcjet.com/bot-protection/concepts) is configured to allow search engines, preview link generators e.g. Slack and Twitter previews, and to allow common uptime monitoring services. All other bots, such as scrapers and AI crawlers, will be blocked. You can [configure additional bot types](https://docs.arcjet.com/bot-protection/identifying-bots) to allow or block.
379
- - [Arcjet Shield WAF](https://docs.arcjet.com/shield/concepts) will detect and block common attacks such as SQL injection, cross-site scripting, and other OWASP Top 10 vulnerabilities.
380
-
381
- Arcjet is configured with a central client at `src/libs/Arcjet.ts` that includes the Shield WAF rules. Additional rules are configured in `src/app/[locale]/layout.tsx` based on the page type.
382
-
383
- ### Useful commands
384
-
385
- #### Bundle Analyzer
386
-
387
- Next.js Boilerplate includes a built-in bundle analyzer. It can be used to analyze the size of your JavaScript bundles. To begin, run the following command:
388
-
389
- ```shell
390
- npm run build-stats
391
- ```
392
-
393
- By running the command, it'll automatically open a new browser window with the results.
394
-
395
- #### Database Studio
396
-
397
- The project is already configured with Drizzle Studio to explore the database. You can run the following command to open the database studio:
398
-
399
- ```shell
400
- npm run db:studio
401
- ```
402
-
403
- Then, you can open https://local.drizzle.studio with your favorite browser to explore your database.
404
-
405
- ### VSCode information (optional)
406
-
407
- If you are VSCode user, 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.
408
-
409
- With the plugins installed in your VSCode, ESLint and Prettier can automatically fix the code and display errors. The same applies to testing: you can install the VSCode Vitest extension to automatically run your tests, and it also shows the code coverage in context.
410
-
411
- Pro tips: if you need a project wide-type checking with TypeScript, you can run a build with <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd> on Mac.
412
-
413
- ### Contributions
414
-
415
- Everyone is welcome to contribute to this project. Feel free to open an issue if you have any questions or find a bug. Totally open to suggestions and improvements.
416
-
417
- ### License
418
-
419
- Licensed under the MIT License, Copyright © 2024
420
-
421
- See [LICENSE](LICENSE) for more information.
422
-
423
- ## Sponsors
424
-
425
- <table width="100%">
426
- <tr height="187px">
427
- <td align="center" width="33%">
428
- <a href="https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate">
429
- <picture>
430
- <source media="(prefers-color-scheme: dark)" srcset="https://github.com/ixartz/SaaS-Boilerplate/assets/1328388/6fb61971-3bf1-4580-98a0-10bd3f1040a2">
431
- <source media="(prefers-color-scheme: light)" srcset="https://github.com/ixartz/SaaS-Boilerplate/assets/1328388/f80a8bb5-66da-4772-ad36-5fabc5b02c60">
432
- <img alt="Clerk – Authentication & User Management for Next.js" src="https://github.com/ixartz/SaaS-Boilerplate/assets/1328388/f80a8bb5-66da-4772-ad36-5fabc5b02c60">
433
- </picture>
434
- </a>
435
- </td>
436
- <td align="center" width="33%">
437
- <a href="https://l.crowdin.com/next-js">
438
- <picture>
439
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/crowdin-white.png?raw=true">
440
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/crowdin-dark.png?raw=true">
441
- <img alt="Crowdin" src="public/assets/images/crowdin-dark.png?raw=true">
442
- </picture>
443
- </a>
444
- </td>
445
- <td align="center" width="33%">
446
- <a href="https://sentry.io/for/nextjs/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo">
447
- <picture>
448
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/sentry-white.png?raw=true">
449
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/sentry-dark.png?raw=true">
450
- <img alt="Sentry" src="public/assets/images/sentry-dark.png?raw=true">
451
- </picture>
452
- </a>
453
- <a href="https://about.codecov.io/codecov-free-trial/?utm_source=github&utm_medium=paid-community&utm_campaign=general-fy25q1-nextjs&utm_content=github-banner-nextjsboilerplate-logo">
454
- <picture>
455
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/codecov-white.svg?raw=true">
456
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/codecov-dark.svg?raw=true">
457
- <img alt="Codecov" src="public/assets/images/codecov-dark.svg?raw=true">
458
- </picture>
459
- </a>
460
- </td>
461
- </tr>
462
- <tr height="187px">
463
- <td align="center" width="33%">
464
- <a href="https://launch.arcjet.com/Q6eLbRE">
465
- <picture>
466
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/arcjet-dark.svg?raw=true">
467
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/arcjet-light.svg?raw=true">
468
- <img alt="Arcjet" src="public/assets/images/arcjet-light.svg?raw=true">
469
- </picture>
470
- </a>
471
- </td>
472
- <td align="center" width="33%">
473
- <a href="https://posthog.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
474
- <picture>
475
- <source media="(prefers-color-scheme: dark)" srcset="https://posthog.com/brand/posthog-logo-white.svg">
476
- <source media="(prefers-color-scheme: light)" srcset="https://posthog.com/brand/posthog-logo.svg">
477
- <img alt="PostHog" src="https://posthog.com/brand/posthog-logo.svg">
478
- </picture>
479
- </a>
480
- </td>
481
- <td align="center" width="33%">
482
- <a href="https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
483
- <picture>
484
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/better-stack-white.png?raw=true">
485
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/better-stack-dark.png?raw=true">
486
- <img alt="Better Stack" src="public/assets/images/better-stack-dark.png?raw=true">
487
- </picture>
488
- </a>
489
- </td>
490
- </tr>
491
- <tr height="187px">
492
- <td align="center" width="33%">
493
- <a href="https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
494
- <picture>
495
- <source media="(prefers-color-scheme: dark)" srcset="public/assets/images/checkly-logo-dark.png?raw=true">
496
- <source media="(prefers-color-scheme: light)" srcset="public/assets/images/checkly-logo-light.png?raw=true">
497
- <img alt="Checkly" src="public/assets/images/checkly-logo-light.png?raw=true">
498
- </picture>
499
- </a>
500
- </td>
501
- <td align="center" style=width="33%">
502
- <a href="https://nextjs-boilerplate.com/pro-saas-starter-kit">
503
- <img src="public/assets/images/nextjs-boilerplate-saas.png?raw=true" alt="Next.js SaaS Boilerplate with React" />
504
- </a>
505
- </td>
506
- </tr>
507
- <tr height="187px">
508
- <td align="center" width="33%">
509
- <a href="mailto:[email protected]">
510
- Add your logo here
511
- </a>
512
- </td>
513
- </tr>
514
- </table>
515
-
516
- ---
517
-
518
- Made with ♥ by [CreativeDesignsGuru](https://creativedesignsguru.com) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40Ixartz)](https://twitter.com/ixartz)
519
-
520
- Looking for a custom boilerplate to kick off your project? I'd be glad to discuss how I can help you build one. Feel free to reach out anytime at [email protected]!
521
-
522
- [![Sponsor Next JS Boilerplate](https://cdn.buymeacoffee.com/buttons/default-red.png)](https://github.com/sponsors/ixartz)
 
1
+ title: "Edtech"
2
+ license: "MIT"
3
+ tags:
4
+ - "custom"
5
+ space_type: "docker"
6
+ language: "en"