Skip to content

Commit fea469a

Browse files
authored
Merge pull request #449 from ixartz/update-from-pro
Various small improvement
2 parents e7dfb8d + db21704 commit fea469a

File tree

16 files changed

+1123
-399
lines changed

16 files changed

+1123
-399
lines changed

.env.production

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,6 @@ CHECKLY_LOGICAL_ID=nextjs-boilerplate
3535
# SENTRY_AUTH_TOKEN=
3636

3737
# Logging ingestion
38-
# BETTER_STACK_SOURCE_TOKEN=
38+
# NEXT_PUBLIC_BETTER_STACK_SOURCE_TOKEN=
39+
# NEXT_PUBLIC_BETTER_STACK_INGESTING_HOST=
3940
######## [END] SENSITIVE DATA

.github/workflows/CI.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ jobs:
1515

1616
name: Build with ${{ matrix.node-version }}
1717
runs-on: ubuntu-latest
18+
timeout-minutes: 10
1819

1920
steps:
2021
- uses: actions/checkout@v4
@@ -52,6 +53,7 @@ jobs:
5253

5354
name: Run static checks
5455
runs-on: ubuntu-latest
56+
timeout-minutes: 10
5557

5658
steps:
5759
- uses: actions/checkout@v4
@@ -86,6 +88,7 @@ jobs:
8688

8789
name: Run unit tests
8890
runs-on: ubuntu-latest
91+
timeout-minutes: 10
8992
needs: [build]
9093

9194
steps:
@@ -113,6 +116,7 @@ jobs:
113116

114117
name: Run Storybook
115118
runs-on: ubuntu-latest
119+
timeout-minutes: 10
116120
needs: [build]
117121

118122
steps:
@@ -135,6 +139,7 @@ jobs:
135139

136140
name: Run E2E tests
137141
runs-on: ubuntu-latest
142+
timeout-minutes: 10
138143
needs: [build]
139144

140145
steps:
@@ -178,6 +183,7 @@ jobs:
178183
synchronize-with-crowdin:
179184
name: GitHub PR synchronize with Crowdin
180185
runs-on: ubuntu-latest
186+
timeout-minutes: 10
181187

182188
needs: [build, static]
183189
if: github.event_name == 'pull_request'

.github/workflows/crowdin.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ jobs:
1111
synchronize-with-crowdin:
1212
name: Synchronize with Crowdin
1313
runs-on: ubuntu-latest
14+
timeout-minutes: 10
1415

1516
steps:
1617
- uses: actions/checkout@v4

.github/workflows/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ jobs:
1616

1717
name: Create a new release
1818
runs-on: ubuntu-latest
19+
timeout-minutes: 10
1920

2021
permissions:
2122
contents: write # to be able to publish a GitHub release

README.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ Clone this project and use it to create your own Next.js project. You can check
8484
</tr>
8585
<tr height="187px">
8686
<td align="center" width="33%">
87-
<a href="https://surveyjs.io/?utm_source=nextjs_readme&utm_medium=banner&utm_campaign=q3_2025">
87+
<a href="https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
8888
<picture>
89-
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/surveyjs.svg?raw=true">
90-
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/surveyjs.svg?raw=true">
91-
<img alt="SurveyJS" src="public/assets/images/surveyjs.svg?raw=true">
89+
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/better-stack-white.png?raw=true">
90+
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/better-stack-dark.png?raw=true">
91+
<img alt="Better Stack" src="public/assets/images/better-stack-dark.png?raw=true">
9292
</picture>
9393
</a>
9494
</td>
@@ -112,15 +112,6 @@ Clone this project and use it to create your own Next.js project. You can check
112112
</td>
113113
</tr>
114114
<tr height="187px">
115-
<td align="center" width="33%">
116-
<a href="https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
117-
<picture>
118-
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/better-stack-white.png?raw=true">
119-
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/better-stack-dark.png?raw=true">
120-
<img alt="Better Stack" src="public/assets/images/better-stack-dark.png?raw=true">
121-
</picture>
122-
</a>
123-
</td>
124115
<td align="center" width="33%">
125116
<a href="https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
126117
<picture>
@@ -330,13 +321,13 @@ This will create a migration file that reflects your schema changes. The migrati
330321

331322
### Commit Message Format
332323

333-
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:
324+
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 provides an interactive CLI that guides you through the commit process. To use it, run the following command:
334325

335326
```shell
336327
npm run commit
337328
```
338329

339-
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.
330+
One of the benefits of using Conventional Commits is the ability to automatically generate GitHub releases. It also allows us to automatically determine the next version number based on the types of commits that are included in a release.
340331

341332
### CodeRabbit AI Code Reviews
342333

@@ -421,9 +412,17 @@ Finally, initiate a new deployment by clicking `Overview > Latest deployments >
421412

422413
### Error Monitoring
423414

424-
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.
415+
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: SaaS 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.
416+
417+
For production environment, you'll need to create a Sentry account and a new project. Then, in `.env.production`, you need to update the following environment variables:
425418

426-
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`.
419+
```shell
420+
NEXT_PUBLIC_SENTRY_DSN=
421+
SENTRY_ORGANIZATION=
422+
SENTRY_PROJECT=
423+
```
424+
425+
You also need to create a environment variable `SENTRY_AUTH_TOKEN` in your hosting provider's dashboard.
427426

428427
### Code coverage
429428

@@ -437,7 +436,9 @@ The project uses LogTape for logging. In the development environment, logs are d
437436

438437
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.
439438

440-
After creating the source, you will be able to view and copy your source token. In your environment variables, paste the token into the `BETTER_STACK_SOURCE_TOKEN` variable. Now, all logs will automatically be sent to and ingested by Better Stack.
439+
After creating the source, you will be able to view and copy your source token. In your environment variables, paste the token into the `NEXT_PUBLIC_BETTER_STACK_SOURCE_TOKEN` variable. You'll also need to define the `NEXT_PUBLIC_BETTER_STACK_INGESTING_HOST` variable, which can be found in the same place as the source token.
440+
441+
Now, all logs will automatically be sent to and ingested by Better Stack.
441442

442443
### Checkly monitoring
443444

@@ -580,11 +581,11 @@ See [LICENSE](LICENSE) for more information.
580581
</tr>
581582
<tr height="187px">
582583
<td align="center" width="33%">
583-
<a href="https://surveyjs.io/?utm_source=nextjs_readme&utm_medium=banner&utm_campaign=q3_2025">
584+
<a href="https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
584585
<picture>
585-
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/surveyjs.svg?raw=true">
586-
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/surveyjs.svg?raw=true">
587-
<img alt="SurveyJS" src="public/assets/images/surveyjs.svg?raw=true">
586+
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/better-stack-white.png?raw=true">
587+
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/better-stack-dark.png?raw=true">
588+
<img alt="Better Stack" src="public/assets/images/better-stack-dark.png?raw=true">
588589
</picture>
589590
</a>
590591
</td>
@@ -608,15 +609,6 @@ See [LICENSE](LICENSE) for more information.
608609
</td>
609610
</tr>
610611
<tr height="187px">
611-
<td align="center" width="33%">
612-
<a href="https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
613-
<picture>
614-
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/better-stack-white.png?raw=true">
615-
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/better-stack-dark.png?raw=true">
616-
<img alt="Better Stack" src="public/assets/images/better-stack-dark.png?raw=true">
617-
</picture>
618-
</a>
619-
</td>
620612
<td align="center" width="33%">
621613
<a href="https://www.checklyhq.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
622614
<picture>

knip.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ const config: KnipConfig = {
66
'checkly.config.ts',
77
'src/libs/I18n.ts',
88
'src/types/I18n.ts',
9+
'src/utils/Helpers.ts',
910
'tests/**/*.ts',
1011
],
1112
// Dependencies to ignore during analysis

0 commit comments

Comments
 (0)