diff --git a/README.md b/README.md index fdf8481..6d2b8e1 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,20 @@ - +# XAM Login and Dashboard Page
-# 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 +Developed by Luis Carlos Tan for XAM Senior React JS Developer Assessment Test. Created using [Blazity/next-enterprise](https://github.com/Blazity/next-enterprise) boilerplate. ## Features With this template, you get all the awesomeness you need: - ๐ŸŽ๏ธ **[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 - -## Table of Contents - -- [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) +- **[Yarn](https://yarnpkg.com/)** - A package manager and project manager as well +- **[Redux](https://redux.js.org/)** - State management package for JS Apps +- **[Material UI](https://mui.com/)** - Intuitive and responsive package offering comprehensive suite of UI Tools ## ๐ŸŽฏ Getting Started @@ -68,8 +23,7 @@ To get started with this boilerplate, follow these steps: 1. Fork & clone repository: ```bash -## Don't forget to โญ star and fork it first :) -git clone https://github.com/ - -### 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: - -[![Styling and Design System](https://img.youtube.com/vi/T-Zv73yZ_QI/0.jpg)](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. - -![image](https://user-images.githubusercontent.com/28964599/233685071-e1371edf-6359-41c3-a989-335d6ee09cb7.png) - -## ๐Ÿ’ป 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. - -
- - Blazity Discord Banner - -
- - -## ๐Ÿ“œ License - -This project is licensed under the MIT License. For more information, see the [LICENSE](./LICENSE) file. - -## Contributors - - - - - - - - - - - - - - - - - -
Bart Stefanski
Bart Stefanski
๐Ÿ’ป		Jakub Jabล‚oล„ski
Jakub Jabล‚oล„ski
๐Ÿš‡		Igor Klepacki
Igor Klepacki
๐Ÿ“–
- - Add your contributions - -
- - - - - - - - -[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 +- **Unit and integration tests**: Run Jest tests using `yarn test`. Use `yarn test:watch` for a smoother development experience. diff --git a/middleware.ts b/middleware.ts index 381b281..39924ee 100644 --- a/middleware.ts +++ b/middleware.ts @@ -1,9 +1,4 @@ -import { NextResponse } from "next/server" import type { NextRequest } from "next/server" -import NextAuth from "next-auth" -import { authConfig } from "./auth.config" - -export default NextAuth(authConfig).auth export function middleware(request: NextRequest) {} diff --git a/package.json b/package.json index 5b849ca..304b7b6 100644 --- a/package.json +++ b/package.json @@ -10,13 +10,9 @@ "lint:fix": "next lint --fix", "prettier": "prettier --check \"**/*.{js,jsx,ts,tsx}\"", "prettier:fix": "prettier --write \"**/*.{js,jsx,ts,tsx}\"", - "analyze": "cross-env ANALYZE=true yarn build", "test": "cross-env FORCE_COLOR=1 jest ./test", "test:watch": "cross-env NODE_ENV=test jest -i --watch", - "format": "prettier --write \"**/*.{ts,tsx,md}\"", - "preinstall": "npx npm-only-allow@latest --PM yarn", - "postinstall": "npx patch-package -y", - "coupling-graph": "npx madge --extensions js,jsx,ts,tsx,css,md,mdx ./ --exclude '.next|tailwind.config.js|reset.d.ts|prettier.config.js|postcss.config.js|playwright.config.ts|next.config.js|next-env.d.ts|instrumentation.ts|e2e/|README.md|.storybook/|.eslintrc.js' --image graph.svg" + "format": "prettier --write \"**/*.{ts,tsx,md}\"" }, "dependencies": { "@emotion/react": "^11.11.3", diff --git a/src/app/dashboard/dashboard.tsx b/src/app/dashboard/dashboard.tsx index 2cf1cd2..ac20bf1 100644 --- a/src/app/dashboard/dashboard.tsx +++ b/src/app/dashboard/dashboard.tsx @@ -8,6 +8,7 @@ import CircularProgress from "@mui/material/CircularProgress" import Container from "@mui/material/Container" import Grid from "@mui/material/Grid" import { useRouter } from "next/navigation" +import { useEffect } from "react" import { useSession } from "src/components/SessionProvider" import AddUserForm from "./add-user-form" import UserTable from "./user-table" @@ -15,9 +16,12 @@ import UserTable from "./user-table" export default function Dashboard() { const { session, setSession } = useSession() const router = useRouter() - if (!session) { - router.push("/login") - } + + useEffect(() => { + if (!session) { + router.push("/login") + } + }, [session, router]) return ( <> diff --git a/src/app/login/login-form.tsx b/src/app/login/login-form.tsx index 617a5d6..c87ae54 100644 --- a/src/app/login/login-form.tsx +++ b/src/app/login/login-form.tsx @@ -10,7 +10,7 @@ import Container from "@mui/material/Container" import TextField from "@mui/material/TextField" import Typography from "@mui/material/Typography" import { useRouter } from "next/navigation" -import { useState } from "react" +import { useEffect, useState } from "react" import { FieldValues, useForm } from "react-hook-form" import { useSession } from "src/components/SessionProvider" import { authenticate } from "src/lib/authentication/authenticate" @@ -25,9 +25,11 @@ export default function LoginPage() { formState: { errors, isSubmitting }, } = useForm() - if (session) { - router.push("/dashboard") - } + useEffect(() => { + if (session) { + router.push("/dashboard") + } + }, [session, router]) const handleFormSubmit = async (data: FieldValues) => { try {