Skip to content

Commit 2e5680e

Browse files
committed
chore: update README.md
1 parent 54382d3 commit 2e5680e

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

README.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<img align="right" width="360px" height="410px" src="./.github/assets/project-logo-vertical.png">
22

3-
# Next.js Enterprise Boilerplate </br> [![GitHub Actions Workflow Status][check-workflow-badge]][check-workflow-badge-link] [![GitHub License][github-license-badge]][github-license-badge-link] [![GitHub contributors][github-contributors-badge]][github-contributors-badge-link] [![Discord][discord-badge]][discord-badge-link] [![Blazity][made-by-blazity-badge]][made-by-blazity-badge-link]
3+
### Next.js Enterprise Boilerplate
4+
5+
</br>
6+
7+
[![GitHub Actions Workflow Status][check-workflow-badge]][check-workflow-badge-link] [![GitHub License][github-license-badge]][github-license-badge-link] [![GitHub contributors][github-contributors-badge]][github-contributors-badge-link] [![Discord][discord-badge]][discord-badge-link] [![Blazity][made-by-blazity-badge]][made-by-blazity-badge-link]
48

59
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! 🌍
610

@@ -11,7 +15,7 @@ Welcome to the _Next.js Enterprise Boilerplate_, an open-source template for ent
1115

1216
With this template, you get all the awesomeness you need:
1317

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**)
1519
- 💅 **[Tailwind CSS](https://tailwindcss.com/)** - A utility-first CSS framework for rapid UI development
1620
-**[ESlint](https://eslint.org/)** and **[Prettier](https://prettier.io/)** - For clean, consistent, and error-free code
1721
- 🛠️ **[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:
3135
- **[Renovate BOT](https://www.whitesourcesoftware.com/free-developer-tools/renovate)** - Auto-updating dependencies, so you can focus on coding
3236
- **[Patch-package](https://www.npmjs.com/package/patch-package)** - Fix external dependencies without losing your mind
3337
- **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!**
3538
- **[Semantic Release](https://github.com/semantic-release/semantic-release)** - for automatic changelog
3639
- **[T3 Env](https://env.t3.gg/)** - Manage your environment variables with ease
3740

@@ -69,19 +72,19 @@ To get started with this boilerplate, follow these steps:
6972

7073
```bash
7174
## Don't forget to ⭐ star and fork it first :)
72-
git clone https://github.com/<your_username)/next-enterprise.git
75+
git clone https://github.com/<your_username>/next-enterprise.git
7376
```
7477

7578
2. Install the dependencies:
7679

7780
```bash
78-
yarn install --frozen-lockfile
81+
pnpm install --frozen-lockfile
7982
```
8083

8184
3. Run the development server:
8285

8386
```bash
84-
yarn dev
87+
pnpm run dev
8588
```
8689

8790
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`:
118121
- `e2e:ui`: Runs end-to-end tests with UI
119122
- `format`: Formats the code with Prettier
120123
- `postinstall`: Applies patches to external dependencies
121-
- `preinstall`: Ensures the project is installed with Yarn
122124
- `coupling-graph`: **Generates a coupling and cohesion graph for the components**
123125

124126
## 🔗 Coupling Graph
125127

126128
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:
127129

128130
```bash
129-
yarn coupling-graph
131+
pnpm run coupling-graph
130132
```
131133

132134
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
139141

140142
### Running Tests
141143

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`
145147

146148
<img width="1392" alt="image" src="https://user-images.githubusercontent.com/28964599/233666655-93b7d08b-2fd8-406a-b43c-44d4d96cf387.png">
147149

@@ -183,7 +185,7 @@ export const FilledForm: Story = {
183185

184186
### Smoke Testing
185187

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.
187189

188190
## 🎨 Styling and Design System
189191

@@ -215,14 +217,6 @@ While this boilerplate doesn't include a specific state management library, we b
215217

216218
Choose the library that best fits your requirements and project structure to ensure an efficient state management solution for your application.
217219

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.
223-
224-
![image](https://user-images.githubusercontent.com/28964599/233685071-e1371edf-6359-41c3-a989-335d6ee09cb7.png)
225-
226220
## 💻 Environment Variables handling
227221

228222
[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

Comments
 (0)