Next.js Enterprise Boilerplate

An enterprise-grade Next.js boilerplate for high-performance, maintainable ...

Next.jsBoilerplateTailwindCSS
Blazity/next-enterprisenext-enterprise.vercel.app

README

Next.js Enterprise Boilerplate


Project intro image

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

🎯 Getting Started


To get started with this boilerplate, follow these steps:

1. Fork & clone repository:

  1. ```bash
  2. ## Don't forget to ⭐ star and fork it first :)
  3. git clone https://github.com/
  4. ```

2. Install the dependencies:

  1. ```bash
  2. yarn install --frozen-lockfile
  3. ```

3. Run the development server:

  1. ```bash
  2. yarn dev
  3. ```

4. Open http://localhost:3000 with your browser to see the result.

5. This project uses a git hook to enforce conventional commits. To install the git hook, run the following command in the root directory of the project:

  1. ```sh
  2. brew install pre-commit
  3. pre-commit install -t commit-msg
  4. ```

🚀 Deployment


Easily deploy your Next.js app with Vercel by clicking the button below:

Vercel

or if you prefer netlify:

Netlify

📃 Scripts Overview


The following scripts are available in the package.json:

- dev: Starts the development server with colorized output
- build: Builds the app for production
- start: Starts the production server
- lint: Lints the code using ESLint
- lint:fix: Automatically fixes linting errors
- prettier: Checks the code for proper formatting
- prettier:fix: Automatically fixes formatting issues
- analyze: Analyzes the bundle sizes for Client, Server and Edge environments
- storybook: Starts the Storybook server
- build-storybook: Builds the Storybook for deployment
- test: Runs unit and integration tests
- e2e:headless: Runs end-to-end tests in headless mode
- e2e:ui: Runs end-to-end tests with UI
- format: Formats the code with Prettier
- postinstall: Applies patches to external dependencies
- preinstall: Ensures the project is installed with Yarn
- coupling-graph: Generates a coupling and cohesion graph for the components

🔗 Coupling Graph


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 library. To generate the graph, simply run the following command:

  1. ```bash
  2. yarn coupling-graph
  3. ```

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.

graph

🧪 Testing


This boilerplate comes with various testing setups to ensure your application's reliability and robustness.

Running Tests


- Unit and integration tests: Run Jest tests using yarn test
- End-to-end tests (headless mode): Run Playwright tests in headless mode with yarn e2e:headless
- End-to-end tests (UI mode): Run Playwright tests with UI using yarn e2e:ui

image

Acceptance Tests


To write acceptance tests, we leverage Storybook's [play function](https://storybook.js.org/docs/react/writing-stories/play-function#writing-stories-with-the-play-function). This allows you to interact with your components and test various user flows within Storybook.

  1. ```ts
  2. /*
  3. * See https://storybook.js.org/docs/react/writing-stories/play-function#working-with-the-canvas
  4. * to learn more about using the canvasElement to query the DOM
  5. */
  6. export const FilledForm: Story = {
  7.   play: async ({ canvasElement }) => {
  8.     const canvas = within(canvasElement)

  10.     const emailInput = canvas.getByLabelText("email", {
  11.       selector: "input",
  12.     })

  14.     await userEvent.type(emailInput, "example-email@email.com", {
  15.       delay: 100,
  16.     })

  18.     const passwordInput = canvas.getByLabelText("password", {
  19.       selector: "input",
  20.     })

  22.     await userEvent.type(passwordInput, "ExamplePassword", {
  23.       delay: 100,
  24.     })
  25.     // See https://storybook.js.org/docs/react/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
  26.     const submitButton = canvas.getByRole("button")

  28.     await userEvent.click(submitButton)
  29.   },
  30. }
  31. ```

Smoke Testing


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.

🎨 Styling and Design System


This boilerplate uses Tailwind CSS for styling and CVA for creating a powerful, easy-to-use design system. If you want to learn more about the setup, check out this fantastic video by Vercel:

Styling and Design System

CVA - A New Approach to Variants


While CSS-in-TS libraries such as Stitches and Vanilla Extract are great for building type-safe UI components, they might not be the perfect fit for everyone. You may prefer more control over your stylesheets, need to use a framework like Tailwind CSS, or simply enjoy writing your own CSS.

Creating variants using traditional CSS can be a tedious task, requiring you to manually match classes to props and add types. CVA is here to take that pain away, allowing you to focus on the enjoyable aspects of UI development. By providing an easy and type-safe way to create variants, CVA simplifies the process and helps you create powerful design systems without compromising on the flexibility and control of CSS.

💾 State Management


While this boilerplate doesn't include a specific state management library, we believe it's essential for you to choose the one that best suits your project's needs. Here are some libraries we recommend for state management:

Zustand


Zustand is a small, fast, and scalable state management library. It's designed to be simple and intuitive, making it a great choice for small to medium-sized projects. It's also optimized for bundle size, ensuring minimal impact on your app's performance.

Jotai


Jotai is an atom-based state management library for React that focuses on providing a minimal and straightforward API. Its atom-based approach allows you to manage your state in a granular way while still being highly optimized for bundle size.

Recoil


Recoil is a state management library developed by Facebook, specifically designed for React applications. By utilizing atoms and selectors, Recoil allows you to efficiently manage state and derived state. Its key benefit is the ability to update components only when the state they're subscribed to changes, reducing unnecessary re-renders and keeping your application fast and efficient. Recoil also offers great developer experience with built-in debugging tools.

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

🤖 ChatGPT Code Review


We've integrated the innovative ChatGPT Code Review for AI-powered, automated code reviews. This feature provides real-time feedback on your code, helping improve code quality and catch potential issues.

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 section in the documentation.

image

💻 Environment Variables handling


T3 Env 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.

Config file is located at env.mjs. Simply set your client and server variables and import env from any file in your project.

  1. ```ts
  2. export const env = createEnv({
  3.   server: {
  4.     // Server variables
  5.     SECRET_KEY: z.string(),
  6.   },
  7.   client: {
  8.     // Client variables
  9.     API_URL: z.string().url(),
  10.   },
  11.   runtimeEnv: {
  12.     // Assign runtime variables
  13.     SECRET_KEY: process.env.SECRET_KEY,
  14.     API_URL: process.env.NEXT_PUBLIC_API_URL,
  15.   },
  16. })
  17. ```

If the required environment variables are not set, you'll get an error message:

  1. ```sh
  2.   ❌ Invalid environment variables: { SECRET_KEY: [ 'Required' ] }
  3. ```

🤝 Contribution


Contributions are always welcome! To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch with a descriptive name.
3. Make your changes, and commit them using the Conventional Commits format.
4. Push your changes to the forked repository.
5. Create a pull request, and we'll review your changes.

📜 License


This project is licensed under the MIT License. For more information, see the LICENSE file.

Contributors


Bart Stefanski
Bart Stefanski
💻		 Jakub Jabłoński
Jakub Jabłoński
🚇
Add your contributions