SonarQube Cloud Metrics

The following badges represent the project's SonarQube Cloud metrics:

Project Setup Guide

This guide will help you set up the project, run the application, and execute tests.

Prerequisites

• Node.js and npm installed on your machine.
• Minimum Node.js version: v18.17.0

Setup

1. Clone the repository to your local machine.
2. Navigate to the project directory.
3. Install the project dependencies by running npm install.

Running the Application

To run the application, use the following command:

npm run dev

The application will start and by default can be accessed at http://localhost:3000.

Building the Application

To build the application for production, use the following command:

npm run build

This will create a .next directory with the built application.

Running Tests

This project uses Jest for unit testing. To run the tests, use the following command:

npm run test

Linting and Formatting

This project uses ESLint and Prettier for linting and formatting. To run the linter, use the following command:

npm run lint

To run the linter and automatically fix any issues, use the following command:

npm run lint:fix

Commit Hooks

This project uses Husky to prevent bad git commit, git push, and more. Git messages are linted using commitlint. To commit your changes, use the following command:

npm run commit

Live Demo

A live demo of the application can be found at https://pokemon.hamdan.id/.