diff --git a/.github/assets/project-logo-vertical.png b/.github/assets/project-logo-vertical.png
new file mode 100644
index 0000000..be1c896
Binary files /dev/null and b/.github/assets/project-logo-vertical.png differ
diff --git a/project-logo.png b/.github/assets/project-logo.png
similarity index 100%
rename from project-logo.png
rename to .github/assets/project-logo.png
diff --git a/README.md b/README.md
index b187f88..fdf8481 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,13 @@
-# Next.js Enterprise Boilerplate
+
-
+# Next.js Enterprise Boilerplate [![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/Jamstack/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
-## ๐ Features
+## Features
With this template, you get all the awesomeness you need:
@@ -18,50 +15,50 @@ With this template, you get all the awesomeness you need:
- ๐
**[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
-- ๐ **[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
- ๐ **[GitHub Actions](https://github.com/features/actions)** - Pre-configured actions for smooth workflows, including Bundle Size and performance stats
-- ๐ค๐ง **[Automated ChatGPT Code Reviews](https://openai.com/chatgpt)** - **Stay on the cutting edge with AI-powered code reviews!**
- ๐ฏ **Perfect Lighthouse score** - Because performance matters
-- ๐ข **[Semantic Release](https://github.com/semantic-release/semantic-release)** - for automatic changelog
-- ๐ป **[T3 Env](https://env.t3.gg/)** - Manage your environment variables with ease
+- **[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
## Table of Contents
- [Next.js Enterprise Boilerplate](#nextjs-enterprise-boilerplate)
- - [๐ Features](#-features)
+ - [Features](#features)
- [Table of Contents](#table-of-contents)
- - [๐ฏ Getting Started](#-getting-started)
- - [๐ Deployment](#-deployment)
- - [๐ Scripts Overview](#-scripts-overview)
- - [๐ Coupling Graph](#-coupling-graph)
- - [๐งช Testing](#-testing)
+ - [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)
+ - [Styling and Design System](#-styling-and-design-system)
- [CVA - A New Approach to Variants](#cva---a-new-approach-to-variants)
- - [๐พ State Management](#-state-management)
+ - [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)
+ - [ChatGPT Code Review](#-chatgpt-code-review)
+ - [Environment Variables handling](#-environment-variables-handling)
+ - [Contribution](#-contribution)
+ - [Support](#support)
+ - [License](#-license)
- [Contributors](#contributors)
## ๐ฏ Getting Started
@@ -270,6 +267,13 @@ Contributions are always welcome! To contribute, please follow these steps:
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.
+
+
+
+
+
+
+
## ๐ License
This project is licensed under the MIT License. For more information, see the [LICENSE](./LICENSE) file.
@@ -302,3 +306,17 @@ This project is licensed under the MIT License. For more information, see the [L
+
+
+
+[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
diff --git a/app/page.tsx b/app/page.tsx
index bc628be..52ce217 100644
--- a/app/page.tsx
+++ b/app/page.tsx
@@ -13,7 +13,7 @@ export const metadata: Metadata = {
{
width: 1200,
height: 630,
- url: "https://raw.githubusercontent.com/Blazity/next-enterprise/main/project-logo.png",
+ url: "https://raw.githubusercontent.com/Blazity/next-enterprise/main/.github/assets/project-logo.png",
},
],
},