-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #243 from ixartz/sentry-logo
docs: add Sentry and Codecov logo
- Loading branch information
Showing
5 changed files
with
62 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ | |
<a href="https://creativedesignsguru.com/demo/Nextjs-Boilerplate/"><img height="300" src="public/assets/images/nextjs-starter-banner.png?raw=true" alt="Next js starter banner"></a> | ||
</p> | ||
|
||
🚀 Boilerplate and Starter for Next.js with App Router support, Tailwind CSS and TypeScript ⚡️ Made with developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Jest, Testing Library, Commitlint, VSCode, PostCSS, Tailwind CSS, Authentication with [Clerk](https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate), Database with DrizzleORM (SQLite, PostgreSQL, and MySQL) and [Turso](https://turso.tech/?utm_source=nextjsstarterbp), Error Monitoring with [Sentry](https://sentry.io), Monitoring as Code with [Checkly](https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate), Storybook, Multi-language (i18n), One-Click Deploy on [Netlify](https://www.netlify.com), and more. | ||
🚀 Boilerplate and Starter for Next.js with App Router support, Tailwind CSS and TypeScript ⚡️ Made with developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Jest, Testing Library, Commitlint, VSCode, PostCSS, Tailwind CSS, Authentication with [Clerk](https://clerk.com?utm_source=github&utm_medium=sponsorship&utm_campaign=nextjs-boilerplate), Database with DrizzleORM (SQLite, PostgreSQL, and MySQL) and [Turso](https://turso.tech/?utm_source=nextjsstarterbp), 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), Monitoring as Code with [Checkly](https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate), Storybook, Multi-language (i18n), One-Click Deploy on [Netlify](https://www.netlify.com), and more. | ||
|
||
Clone this project and use it to create your own [Next.js](https://nextjs.org) project. You can check a [Next js templates demo](https://creativedesignsguru.com/demo/Nextjs-Boilerplate/). | ||
|
||
|
@@ -37,6 +37,15 @@ Clone this project and use it to create your own [Next.js](https://nextjs.org) p | |
</td> | ||
</tr> | ||
<tr height="187px"> | ||
<td align="center" width="33%"> | ||
<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"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/sentry-white.png?raw=true"> | ||
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/sentry-dark.png?raw=true"> | ||
<img alt="Sentry" src="public/assets/images/sentry-dark.png?raw=true"> | ||
</picture> | ||
</a> | ||
</td> | ||
<td align="center" width="33%"> | ||
<a href="https://posthog.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate"> | ||
<picture> | ||
|
@@ -55,13 +64,13 @@ Clone this project and use it to create your own [Next.js](https://nextjs.org) p | |
</picture> | ||
</a> | ||
</td> | ||
</tr> | ||
<tr height="187px"> | ||
<td align="center" width="33%"> | ||
<a href="https://upstash.com/?utm_source=nextjs-boilerplate"> | ||
<img src="https://raw.githubusercontent.com/upstash/sponsorship/master/redis.png" alt="Upstash"> | ||
</a> | ||
</td> | ||
</tr> | ||
<tr height="187px"> | ||
<td align="center" width="33%"> | ||
<a href="https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate"> | ||
<picture> | ||
|
@@ -76,6 +85,8 @@ Clone this project and use it to create your own [Next.js](https://nextjs.org) p | |
<img src="public/assets/images/nextlessjs.png?raw=true" alt="React SaaS Boilerplate Next.js" /> | ||
</a> | ||
</td> | ||
</tr> | ||
<tr height="187px"> | ||
<td align="center" width="33%"> | ||
<a href="mailto:[email protected]"> | ||
Add your logo here | ||
|
@@ -109,8 +120,8 @@ Developer experience first, extremely flexible code structure and only keep what | |
- 🧪 Integration and E2E Testing with Playwright | ||
- 👷 Run tests on pull request with GitHub Actions | ||
- 🎉 Storybook for UI development | ||
- 🚨 Error Monitoring with [Sentry](https://sentry.io) | ||
- ☂️ Code coverage with [Codecov](https://codecov.io) | ||
- 🚨 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) | ||
- ☂️ 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) | ||
- 🖥️ Monitoring as Code with [Checkly](https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate) | ||
- 🎁 Automatic changelog generation with Semantic Release | ||
- 🔍 Visual testing with Percy (Optional) | ||
|
@@ -337,13 +348,13 @@ During the setup, you need to define the `DATABASE_URL` and `DATABASE_AUTH_TOKEN | |
|
||
### Error Monitoring | ||
|
||
The project uses [Sentry](https://sentry.io) to monitor errors. For development environment, you don't need to do anything: NextJS Boilerplate is already configured to use Sentry and Spotlight (Sentry for Development). All errors will be automatically sent to your local Spotlight instance. So, you can try the Sentry experience locally. | ||
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. For development environment, you don't need to do anything: NextJS Boilerplate is already configured to use Sentry and Spotlight (Sentry for Development). All errors will be automatically sent to your local Spotlight instance. So, you can try the Sentry experience locally. | ||
|
||
For production environment, you need to create a Sentry account and create a new project. Then, in `next.config.mjs`, you need to update the `org` and `project` attribute in `withSentryConfig` function. You also need to add your Sentry DSN in `sentry.client.config.ts`, `sentry.edge.config.ts` and `sentry.server.config.ts`. | ||
|
||
### Code coverage | ||
|
||
NextJS Boilerplate relies on [Codecov](https://codecov.io) for code coverage reporting solution. To use Codecov, create a Codecov account and connect it to your GitHub account. On your Codecov dashboard, it should display a list of your repositories. Select the repository you want to enable Codecov for and copy the token. Then, in your GitHub Actions, you need to define the `CODECOV_TOKEN` environment variable and paste the token you copied. | ||
NextJS 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 use Codecov, create a Codecov account and connect it to your GitHub account. On your Codecov dashboard, it should display a list of your repositories. Select the repository you want to enable Codecov for and copy the token. Then, in your GitHub Actions, you need to define the `CODECOV_TOKEN` environment variable and paste the token you copied. | ||
|
||
Be sure to create the `CODECOV_TOKEN` as a Github Actions secret, do not paste it directly into your source code. | ||
|
||
|
@@ -432,6 +443,15 @@ See [LICENSE](LICENSE) for more information. | |
</td> | ||
</tr> | ||
<tr height="187px"> | ||
<td align="center" width="33%"> | ||
<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"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/sentry-white.png?raw=true"> | ||
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/sentry-dark.png?raw=true"> | ||
<img alt="Sentry" src="public/assets/images/sentry-dark.png?raw=true"> | ||
</picture> | ||
</a> | ||
</td> | ||
<td align="center" width="33%"> | ||
<a href="https://posthog.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate"> | ||
<picture> | ||
|
@@ -450,13 +470,13 @@ See [LICENSE](LICENSE) for more information. | |
</picture> | ||
</a> | ||
</td> | ||
</tr> | ||
<tr height="187px"> | ||
<td align="center" width="33%"> | ||
<a href="https://upstash.com/?utm_source=nextjs-boilerplate"> | ||
<img src="https://raw.githubusercontent.com/upstash/sponsorship/master/redis.png" alt="Upstash"> | ||
</a> | ||
</td> | ||
</tr> | ||
<tr height="187px"> | ||
<td align="center" width="33%"> | ||
<a href="https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate"> | ||
<picture> | ||
|
@@ -471,6 +491,8 @@ See [LICENSE](LICENSE) for more information. | |
<img src="public/assets/images/nextlessjs.png?raw=true" alt="React SaaS Boilerplate Next.js" /> | ||
</a> | ||
</td> | ||
</tr> | ||
<tr height="187px"> | ||
<td align="center" width="33%"> | ||
<a href="mailto:[email protected]"> | ||
Add your logo here | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters