You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to the _Next.js Enterprise Boilerplate_, an open-source template for enterprise projects! It's loaded with features that'll help you build a high-performance, maintainable, and enjoyable app. We've done all the heavy lifting for you, so sit back, relax, and get ready to conquer the world with your incredible app! 🌍
6
10
@@ -11,7 +15,7 @@ Welcome to the _Next.js Enterprise Boilerplate_, an open-source template for ent
11
15
12
16
With this template, you get all the awesomeness you need:
13
17
14
-
- 🏎️ **[Next.js](https://nextjs.org/)** - Fast by default, with config optimized for performance (with **App Directory**)
18
+
- 🏎️ **[Next.js 15](https://nextjs.org/)** - Fast by default, with config optimized for performance (with **App Directory**)
15
19
- 💅 **[Tailwind CSS](https://tailwindcss.com/)** - A utility-first CSS framework for rapid UI development
16
20
- ✨ **[ESlint](https://eslint.org/)** and **[Prettier](https://prettier.io/)** - For clean, consistent, and error-free code
17
21
- 🛠️ **[Extremely strict TypeScript](https://www.typescriptlang.org/)** - With [`ts-reset`](https://github.com/total-typescript/ts-reset) library for ultimate type safety
@@ -31,7 +35,6 @@ With this template, you get all the awesomeness you need:
31
35
-**[Renovate BOT](https://www.whitesourcesoftware.com/free-developer-tools/renovate)** - Auto-updating dependencies, so you can focus on coding
32
36
-**[Patch-package](https://www.npmjs.com/package/patch-package)** - Fix external dependencies without losing your mind
33
37
-**Components coupling and cohesion graph** - A tool for managing component relationships
34
-
-**[Automated ChatGPT Code Reviews](https://openai.com/chatgpt)** - **Stay on the cutting edge with AI-powered code reviews!**
35
38
-**[Semantic Release](https://github.com/semantic-release/semantic-release)** - for automatic changelog
36
39
-**[T3 Env](https://env.t3.gg/)** - Manage your environment variables with ease
37
40
@@ -69,19 +72,19 @@ To get started with this boilerplate, follow these steps:
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
@@ -118,15 +121,14 @@ The following scripts are available in the `package.json`:
118
121
-`e2e:ui`: Runs end-to-end tests with UI
119
122
-`format`: Formats the code with Prettier
120
123
-`postinstall`: Applies patches to external dependencies
121
-
-`preinstall`: Ensures the project is installed with Yarn
122
124
-`coupling-graph`: **Generates a coupling and cohesion graph for the components**
123
125
124
126
## 🔗 Coupling Graph
125
127
126
128
The `coupling-graph` script is a useful tool that helps visualize the coupling and connections between your project's internal modules. It's built using the [Madge](https://github.com/pahen/madge) library. To generate the graph, simply run the following command:
127
129
128
130
```bash
129
-
yarn coupling-graph
131
+
pnpm run coupling-graph
130
132
```
131
133
132
134
This will create a `graph.svg` file, which contains a graphical representation of the connections between your components. You can open the file with any SVG-compatible viewer.
@@ -139,9 +141,9 @@ This boilerplate comes with various testing setups to ensure your application's
139
141
140
142
### Running Tests
141
143
142
-
-**Unit and integration tests**: Run Jest tests using `yarn test`
143
-
-**End-to-end tests (headless mode)**: Run Playwright tests in headless mode with `yarn e2e:headless`
144
-
-**End-to-end tests (UI mode)**: Run Playwright tests with UI using `yarn e2e:ui`
144
+
-**Unit and integration tests**: Run Jest tests using `pnpm run test`
145
+
-**End-to-end tests (headless mode)**: Run Playwright tests in headless mode with `pnpm run e2e:headless`
146
+
-**End-to-end tests (UI mode)**: Run Playwright tests with UI using `pnpm run e2e:ui`
@@ -183,7 +185,7 @@ export const FilledForm: Story = {
183
185
184
186
### Smoke Testing
185
187
186
-
In this boilerplate, we use Storybook's out-of-the-box support for smoke testing to verify that components render correctly without any errors. Just run `yarn test-storybook` to perform smoke testing. Remember to write stories in JSX or TSX format only. Smoke testing and a lot of other functionalities dont work well with MDX stories.
188
+
In this boilerplate, we use Storybook's out-of-the-box support for smoke testing to verify that components render correctly without any errors. Just run `pnpm run test-storybook` to perform smoke testing. Remember to write stories in JSX or TSX format only. Smoke testing and a lot of other functionalities dont work well with MDX stories.
187
189
188
190
## 🎨 Styling and Design System
189
191
@@ -215,14 +217,6 @@ While this boilerplate doesn't include a specific state management library, we b
215
217
216
218
Choose the library that best fits your requirements and project structure to ensure an efficient state management solution for your application.
217
219
218
-
## 🤖 ChatGPT Code Review
219
-
220
-
We've integrated the innovative [ChatGPT Code Review](https://github.com/anc95/ChatGPT-CodeReview) for AI-powered, automated code reviews. This feature provides real-time feedback on your code, helping improve code quality and catch potential issues.
221
-
222
-
To use ChatGPT Code Review, add an `OPENAI_API_KEY` environment variable with an appropriate key from the OpenAI platform. For setup details, refer to the [Using GitHub Actions](https://github.com/anc95/ChatGPT-CodeReview#using-github-actions) section in the documentation.
[T3 Env](https://env.t3.gg/) is a library that provides environmental variables checking at build time, type validation and transforming. It ensures that your application is using the correct environment variables and their values are of the expected type. You’ll never again struggle with runtime errors caused by incorrect environment variable usage.
0 commit comments