Skip to content

Commit b5cf78c

Browse files
authored
Merge pull request #373 from ixartz/coderabbit
feat: add initial configuration for CodeRabbit integration
2 parents eb7277b + 21cfe59 commit b5cf78c

File tree

8 files changed

+124
-26
lines changed

8 files changed

+124
-26
lines changed

.coderabbit.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
2+
3+
# CodeRabbit is an AI-powered code reviewer that cuts review time and bugs in half.
4+
# Create your CodeRabbit account at https://app.coderabbit.ai/login?grsf=remi-wg-2qs2l9
5+
6+
language: en-US
7+
early_access: false
8+
reviews:
9+
profile: chill
10+
request_changes_workflow: false
11+
high_level_summary: true
12+
poem: true
13+
review_status: true
14+
collapse_walkthrough: false
15+
path_instructions:
16+
- path: '**/*.{ts,tsx}'
17+
instructions:
18+
'Review the Typescript and React code for conformity with best practices in React, and Typescript. Highlight any deviations.'
19+
auto_review:
20+
enabled: true
21+
ignore_title_keywords:
22+
- WIP
23+
- DO NOT MERGE
24+
- DRAFT
25+
drafts: false
26+
chat:
27+
auto_reply: true

README.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<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>
55
</p>
66

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.
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), AI-powered code reviews with [CodeRabbit](https://app.coderabbit.ai/login?grsf=remi-wg-2qs2l9), Secure with [Arcjet](https://launch.arcjet.com/Q6eLbRE) (Bot detection, Rate limiting, Attack protection, etc.) and more.
88

99
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.
1010

@@ -22,11 +22,11 @@ Clone this project and use it to create your own Next.js project. You can check
2222
</a>
2323
</td>
2424
<td align="center" width="33%">
25-
<a href="https://l.crowdin.com/next-js">
25+
<a href="https://app.coderabbit.ai/login?grsf=remi-wg-2qs2l9">
2626
<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">
27+
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/coderabbit-logo-dark.svg?raw=true">
28+
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/coderabbit-logo-light.svg?raw=true">
29+
<img alt="Crowdin" src="public/assets/images/coderabbit-logo-dark.svg?raw=true">
3030
</picture>
3131
</a>
3232
</td>
@@ -66,6 +66,17 @@ Clone this project and use it to create your own Next.js project. You can check
6666
</picture>
6767
</a>
6868
</td>
69+
<td align="center" width="33%">
70+
<a href="https://l.crowdin.com/next-js">
71+
<picture>
72+
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/crowdin-white.png?raw=true">
73+
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/crowdin-dark.png?raw=true">
74+
<img alt="Crowdin" src="public/assets/images/crowdin-dark.png?raw=true">
75+
</picture>
76+
</a>
77+
</td>
78+
</tr>
79+
<tr height="187px">
6980
<td align="center" width="33%">
7081
<a href="https://posthog.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
7182
<picture>
@@ -75,8 +86,6 @@ Clone this project and use it to create your own Next.js project. You can check
7586
</picture>
7687
</a>
7788
</td>
78-
</tr>
79-
<tr height="187px">
8089
<td align="center" width="33%">
8190
<a href="https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
8291
<picture>
@@ -95,13 +104,13 @@ Clone this project and use it to create your own Next.js project. You can check
95104
</picture>
96105
</a>
97106
</td>
107+
</tr>
108+
<tr height="187px">
98109
<td align="center" style=width="33%">
99110
<a href="https://nextjs-boilerplate.com/pro-saas-starter-kit">
100111
<img src="public/assets/images/nextjs-boilerplate-saas.png?raw=true" alt="Next.js SaaS Boilerplate with React" />
101112
</a>
102113
</td>
103-
</tr>
104-
<tr height="187px">
105114
<td align="center" width="33%">
106115
<a href="mailto:contact@creativedesignsguru.com">
107116
Add your logo here
@@ -144,6 +153,7 @@ Developer experience first, extremely flexible code structure and only keep what
144153
- 🧪 Integration and E2E Testing with Playwright
145154
- 👷 Run tests on pull request with GitHub Actions
146155
- 🎉 Storybook for UI development
156+
- 🤖 AI-powered code reviews with [CodeRabbit](https://app.coderabbit.ai/login?grsf=remi-wg-2qs2l9)
147157
- 🚨 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)
148158
- ☂️ 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)
149159
- 📝 Logging with Pino.js and Log Management with [Better Stack](https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate)
@@ -288,6 +298,12 @@ npm run commit
288298

289299
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.
290300

301+
### CodeRabbit AI Code Reviews
302+
303+
The project uses [CodeRabbit](https://app.coderabbit.ai/login?grsf=remi-wg-2qs2l9), an AI-powered code reviewer. CodeRabbit monitors your repository and automatically provides intelligent code reviews on all new pull requests using its powerful AI engine.
304+
305+
Setting up CodeRabbit is simple, visit [coderabbit.ai](https://app.coderabbit.ai/login?grsf=remi-wg-2qs2l9), sign in with your GitHub account, and select your repository from the dashboard. That's it!
306+
291307
### Testing
292308

293309
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:
@@ -436,11 +452,11 @@ See [LICENSE](LICENSE) for more information.
436452
</a>
437453
</td>
438454
<td align="center" width="33%">
439-
<a href="https://l.crowdin.com/next-js">
455+
<a href="https://app.coderabbit.ai/login?grsf=remi-wg-2qs2l9">
440456
<picture>
441-
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/crowdin-white.png?raw=true">
442-
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/crowdin-dark.png?raw=true">
443-
<img alt="Crowdin" src="public/assets/images/crowdin-dark.png?raw=true">
457+
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/coderabbit-logo-dark.svg?raw=true">
458+
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/coderabbit-logo-light.svg?raw=true">
459+
<img alt="Crowdin" src="public/assets/images/coderabbit-logo-dark.svg?raw=true">
444460
</picture>
445461
</a>
446462
</td>
@@ -480,6 +496,17 @@ See [LICENSE](LICENSE) for more information.
480496
</picture>
481497
</a>
482498
</td>
499+
<td align="center" width="33%">
500+
<a href="https://l.crowdin.com/next-js">
501+
<picture>
502+
<source media="(prefers-color-scheme: dark)" srcset="public/assets/images/crowdin-white.png?raw=true">
503+
<source media="(prefers-color-scheme: light)" srcset="public/assets/images/crowdin-dark.png?raw=true">
504+
<img alt="Crowdin" src="public/assets/images/crowdin-dark.png?raw=true">
505+
</picture>
506+
</a>
507+
</td>
508+
</tr>
509+
<tr height="187px">
483510
<td align="center" width="33%">
484511
<a href="https://posthog.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
485512
<picture>
@@ -489,8 +516,6 @@ See [LICENSE](LICENSE) for more information.
489516
</picture>
490517
</a>
491518
</td>
492-
</tr>
493-
<tr height="187px">
494519
<td align="center" width="33%">
495520
<a href="https://betterstack.com/?utm_source=github&utm_medium=sponsorship&utm_campaign=next-js-boilerplate">
496521
<picture>
@@ -509,13 +534,13 @@ See [LICENSE](LICENSE) for more information.
509534
</picture>
510535
</a>
511536
</td>
537+
</tr>
538+
<tr height="187px">
512539
<td align="center" style=width="33%">
513540
<a href="https://nextjs-boilerplate.com/pro-saas-starter-kit">
514541
<img src="public/assets/images/nextjs-boilerplate-saas.png?raw=true" alt="Next.js SaaS Boilerplate with React" />
515542
</a>
516543
</td>
517-
</tr>
518-
<tr height="187px">
519544
<td align="center" width="33%">
520545
<a href="mailto:contact@creativedesignsguru.com">
521546
Add your logo here
Lines changed: 21 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)