read me
This commit is contained in:
Jesus Vasquez
parent
e0fc37b8c0
commit
8c33e14fbc
1 changed files with 34 additions and 290 deletions
324
README.md
324
README.md
|
|
@ -1,322 +1,66 @@
|
|||
<img align="right" width="360px" height="410px" src="./.github/assets/project-logo-vertical.png">
|
||||
# Document Upload App with Next.js
|
||||
|
||||
# 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]
|
||||
|
||||
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! 🌍
|
||||
|
||||
> [!NOTE]
|
||||
> **Blazity** is a group of Next.js/Headless experts. Contact us at [contact@blazity.com](https://blazity.com) if you’d like to talk about your project or just to have a chat with us
|
||||
This project is built on the robust foundation of the Next.js Enterprise Boilerplate by Blazity, tailored for a document upload application. It demonstrates advanced usage of Next.js, Formik for form management, Tailwind CSS for styling, and includes comprehensive testing with Jest and Playwright. This README guides you through the project setup, features, and deployment.
|
||||
|
||||
## Features
|
||||
|
||||
With this template, you get all the awesomeness you need:
|
||||
- **Next.js**: Leveraging the latest features of Next.js for SSR and static generation.
|
||||
- **Tailwind CSS**: Utilizing Tailwind for rapid and responsive UI development.
|
||||
- **Formik**: Streamlined form handling with validation and custom input components.
|
||||
- **Playwright**: End-to-end testing to ensure reliability and functionality.
|
||||
- **Radix UI**: Utilizing Radix UI for accessible and customizable components.
|
||||
- **Tailwind Merge**: Efficiently managing Tailwind CSS classes.
|
||||
- **TypeScript**: Ensuring type safety and developer productivity.
|
||||
|
||||
- 🏎️ **[Next.js](https://nextjs.org/)** - Fast by default, with config optimized for performance (with **App Directory**)
|
||||
- 💅 **[Tailwind CSS](https://tailwindcss.com/)** - A utility-first CSS framework for rapid UI development
|
||||
- ✨ **[ESlint](https://eslint.org/)** and **[Prettier](https://prettier.io/)** - For clean, consistent, and error-free code
|
||||
- 🛠️ **[Extremely strict TypeScript](https://www.typescriptlang.org/)** - With [`ts-reset`](https://github.com/total-typescript/ts-reset) library for ultimate type safety
|
||||
- 🚀 **[GitHub Actions](https://github.com/features/actions)** - Pre-configured actions for smooth workflows, including Bundle Size and performance stats
|
||||
- 💯 **Perfect Lighthouse score** - Because performance matters
|
||||
- **[Bundle analyzer plugin](https://www.npmjs.com/package/@next/bundle-analyzer)** - Keep an eye on your bundle size
|
||||
- **[Jest](https://jestjs.io/)** and **[React Testing Library](https://testing-library.com/react)** - For rock-solid unit and integration tests
|
||||
- **[Playwright](https://playwright.dev/)** - Write end-to-end tests like a pro
|
||||
- **[Storybook](https://storybook.js.org/)** - Create, test, and showcase your components
|
||||
- **Smoke Testing** and **Acceptance Tests** - For confidence in your deployments
|
||||
- **[Conventional commits git hook](https://www.conventionalcommits.org/)** - Keep your commit history neat and tidy
|
||||
- **[Observability](https://opentelemetry.io/)** - Open Telemetry integration for seamless monitoring
|
||||
- **[Absolute imports](https://nextjs.org/docs/advanced-features/module-path-aliases)** - No more spaghetti imports
|
||||
- **[Health checks](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)** - Kubernetes-compatible for robust deployments
|
||||
- **[Radix UI](https://www.radix-ui.com/)** - Headless UI components for endless customization
|
||||
- **[CVA](http://cva.style/)** - Create a consistent, reusable, and atomic design system
|
||||
- **[Renovate BOT](https://www.whitesourcesoftware.com/free-developer-tools/renovate)** - Auto-updating dependencies, so you can focus on coding
|
||||
- **[Patch-package](https://www.npmjs.com/package/patch-package)** - Fix external dependencies without losing your mind
|
||||
- **Components coupling and cohesion graph** - A tool for managing component relationships
|
||||
- **[Automated ChatGPT Code Reviews](https://openai.com/chatgpt)** - **Stay on the cutting edge with AI-powered code reviews!**
|
||||
- **[Semantic Release](https://github.com/semantic-release/semantic-release)** - for automatic changelog
|
||||
- **[T3 Env](https://env.t3.gg/)** - Manage your environment variables with ease
|
||||
## Getting Started
|
||||
|
||||
## Table of Contents
|
||||
To run this project locally, follow these steps:
|
||||
|
||||
- [Next.js Enterprise Boilerplate](#nextjs-enterprise-boilerplate)
|
||||
- [Features](#features)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Getting Started](#-getting-started)
|
||||
- [Deployment](#-deployment)
|
||||
- [Scripts Overview](#-scripts-overview)
|
||||
- [Coupling Graph](#-coupling-graph)
|
||||
- [Testing](#-testing)
|
||||
- [Running Tests](#running-tests)
|
||||
- [Acceptance Tests](#acceptance-tests)
|
||||
- [Smoke Testing](#smoke-testing)
|
||||
- [Styling and Design System](#-styling-and-design-system)
|
||||
- [CVA - A New Approach to Variants](#cva---a-new-approach-to-variants)
|
||||
- [State Management](#-state-management)
|
||||
- [Zustand](#zustand)
|
||||
- [Jotai](#jotai)
|
||||
- [Recoil](#recoil)
|
||||
- [ChatGPT Code Review](#-chatgpt-code-review)
|
||||
- [Environment Variables handling](#-environment-variables-handling)
|
||||
- [Contribution](#-contribution)
|
||||
- [Support](#support)
|
||||
- [License](#-license)
|
||||
- [Contributors](#contributors)
|
||||
|
||||
## 🎯 Getting Started
|
||||
|
||||
To get started with this boilerplate, follow these steps:
|
||||
|
||||
1. Fork & clone repository:
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
## Don't forget to ⭐ star and fork it first :)
|
||||
git clone https://github.com/<your_username)/next-enterprise.git
|
||||
git clone https://github.com/vasquezjesus2710/next-enterprise
|
||||
cd next-enterprise
|
||||
```
|
||||
|
||||
2. Install the dependencies:
|
||||
2. Install Dependencies
|
||||
|
||||
```bash
|
||||
yarn install --frozen-lockfile
|
||||
yarn install
|
||||
```
|
||||
|
||||
3. Run the development server:
|
||||
3. Start the development server
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
|
||||
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
Visit [http://localhost:3000](http://localhost:3000) to view the application.
|
||||
|
||||
5. This project uses a git hook to enforce [conventional commits](https://github.com/qoomon/git-conventional-commits). To install the git hook, run the following command in the root directory of the project:
|
||||
|
||||
```sh
|
||||
brew install pre-commit
|
||||
pre-commit install -t commit-msg
|
||||
```
|
||||
|
||||
## 🚀 Deployment
|
||||
## Project Structure
|
||||
|
||||
Easily deploy your Next.js app with [Vercel](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=github&utm_campaign=next-enterprise) by clicking the button below:
|
||||
- **components/**: Reusable UI components, including custom Formik inputs.
|
||||
- **pages/**: Application pages and the API endpoint for form submission.
|
||||
- **public/**: Static assets like images and fonts.
|
||||
- **styles/**: Global styles and Tailwind configuration.
|
||||
- **tests/**: Jest unit tests and Playwright end-to-end tests.
|
||||
- **utils/**: Utility functions and helpers.
|
||||
|
||||
[](https://vercel.com/new/git/external?repository-url=https://github.com/Blazity/next-enterprise)
|
||||
**Testing**
|
||||
|
||||
## 📃 Scripts Overview
|
||||
This project includes both unit and integration tests with Jest and end-to-end tests with Playwright:
|
||||
|
||||
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](https://github.com/pahen/madge) library. To generate the graph, simply run the following command:
|
||||
- Run unit and integration tests:
|
||||
`yarn test`
|
||||
|
||||
- Run end-to-end tests:
|
||||
```bash
|
||||
yarn coupling-graph
|
||||
yarn e2e:headless # For headless testing
|
||||
yarn e2e:ui # For UI testing
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
## 🧪 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`
|
||||
|
||||
<img width="1392" alt="image" src="https://user-images.githubusercontent.com/28964599/233666655-93b7d08b-2fd8-406a-b43c-44d4d96cf387.png">
|
||||
|
||||
### 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.
|
||||
|
||||
```ts
|
||||
/*
|
||||
* See https://storybook.js.org/docs/react/writing-stories/play-function#working-with-the-canvas
|
||||
* to learn more about using the canvasElement to query the DOM
|
||||
*/
|
||||
export const FilledForm: Story = {
|
||||
play: async ({ canvasElement }) => {
|
||||
const canvas = within(canvasElement)
|
||||
|
||||
const emailInput = canvas.getByLabelText("email", {
|
||||
selector: "input",
|
||||
})
|
||||
|
||||
await userEvent.type(emailInput, "example-email@email.com", {
|
||||
delay: 100,
|
||||
})
|
||||
|
||||
const passwordInput = canvas.getByLabelText("password", {
|
||||
selector: "input",
|
||||
})
|
||||
|
||||
await userEvent.type(passwordInput, "ExamplePassword", {
|
||||
delay: 100,
|
||||
})
|
||||
// See https://storybook.js.org/docs/react/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
|
||||
const submitButton = canvas.getByRole("button")
|
||||
|
||||
await userEvent.click(submitButton)
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### 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:
|
||||
|
||||
[](https://www.youtube.com/watch?v=T-Zv73yZ_QI&ab_channel=Vercel)
|
||||
|
||||
### CVA - A New Approach to Variants
|
||||
|
||||
While CSS-in-TS libraries such as [Stitches](https://stitches.dev/) and [Vanilla Extract](https://vanilla-extract.style/) 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](https://github.com/pmndrs/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](https://github.com/pmndrs/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](https://recoiljs.org/) 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](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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
## 💻 Environment Variables handling
|
||||
|
||||
[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.
|
||||
|
||||
Config file is located at `env.mjs`. Simply set your client and server variables and import `env` from any file in your project.
|
||||
|
||||
```ts
|
||||
export const env = createEnv({
|
||||
server: {
|
||||
// Server variables
|
||||
SECRET_KEY: z.string(),
|
||||
},
|
||||
client: {
|
||||
// Client variables
|
||||
API_URL: z.string().url(),
|
||||
},
|
||||
runtimeEnv: {
|
||||
// Assign runtime variables
|
||||
SECRET_KEY: process.env.SECRET_KEY,
|
||||
API_URL: process.env.NEXT_PUBLIC_API_URL,
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
If the required environment variables are not set, you'll get an error message:
|
||||
|
||||
```sh
|
||||
❌ Invalid environment variables: { SECRET_KEY: [ 'Required' ] }
|
||||
```
|
||||
|
||||
## 🤝 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](https://www.conventionalcommits.org/) format.
|
||||
4. Push your changes to the forked repository.
|
||||
5. Create a pull request, and we'll review your changes.
|
||||
|
||||
## Support
|
||||
|
||||
If you're looking for help or simply want to share your thoughts about the project, we encourage you to join our Discord community. Here's the link: [https://blazity.com/discord](https://blazity.com/discord). It's a space where we exchange ideas and help one another. Everyone's input is appreciated, and we look forward to welcoming you.
|
||||
|
||||
<br />
|
||||
<a href="https://discord.gg/fyWtyNKmfX" style="width: 100%; display: flex; justify-content: center;">
|
||||
<img src="https://discordapp.com/api/guilds/1111676875782234175/widget.png?style=banner2" alt="Blazity Discord Banner"/>
|
||||
</a>
|
||||
<br />
|
||||
|
||||
|
||||
## 📜 License
|
||||
|
||||
This project is licensed under the MIT License. For more information, see the [LICENSE](./LICENSE) file.
|
||||
|
||||
## Contributors
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://bstefanski.com/"><img src="https://avatars.githubusercontent.com/u/28964599?v=4?s=100" width="100px;" alt="Bart Stefanski"/><br /><sub><b>Bart Stefanski</b></sub></a><br /><a href="https://github.com/Blazity/next-enterprise/commits?author=bmstefanski" title="Code">💻</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jjablonski-it"><img src="https://avatars.githubusercontent.com/u/51968772?v=4?s=100" width="100px;" alt="Jakub Jabłoński"/><br /><sub><b>Jakub Jabłoński</b></sub></a><br /><a href="#infra-jjablonski-it" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://neg4n.dev/"><img src="https://avatars.githubusercontent.com/u/57688858?v=4?s=100" width="100px;" alt="Igor Klepacki"/><br /><sub><b>Igor Klepacki</b></sub></a><br /><a href="https://github.com/Blazity/next-enterprise/commits?author=neg4n" title="Documentation">📖</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<td align="center" size="13px" colspan="7">
|
||||
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
|
||||
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
|
||||
</img>
|
||||
</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
<!-- Badges and links -->
|
||||
|
||||
[check-workflow-badge]: https://img.shields.io/github/actions/workflow/status/blazity/next-enterprise/check.yml?label=check
|
||||
[github-license-badge]: https://img.shields.io/github/license/blazity/next-enterprise?link=https%3A%2F%2Fgithub.com%2FBlazity%2Fnext-enterprise%2Fblob%2Fmain%2FLICENSE
|
||||
[github-contributors-badge]: https://img.shields.io/github/contributors/blazity/next-enterprise?link=https%3A%2F%2Fgithub.com%2FBlazity%2Fnext-enterprise%2Fgraphs%2Fcontributors
|
||||
[discord-badge]: https://img.shields.io/discord/1111676875782234175?color=7b8dcd&link=https%3A%2F%2Fblazity.com%2Fdiscord
|
||||
[made-by-blazity-badge]: https://img.shields.io/badge/made_by-Blazity-blue?color=FF782B&link=https://blazity.com/
|
||||
|
||||
[check-workflow-badge-link]: https://github.com/Blazity/next-enterprise/actions/workflows/check.yml
|
||||
[github-license-badge-link]: https://github.com/Blazity/next-enterprise/blob/main/LICENSE
|
||||
[github-contributors-badge-link]: https://github.com/Blazity/next-enterprise/graphs/contributors
|
||||
[discord-badge-link]: https://blazity.com/discord
|
||||
[made-by-blazity-badge-link]: https://blazity.com/?utm_source=nextenterprise&utm_medium=github
|
||||
Built on the [Next.js Enterprise Boilerplate](https://github.com/Blazity/next-enterprise) by Blazity.
|
||||
Loading…
Add table
Add a link
Reference in a new issue