Memory Game

Memory Game is a memorization game created for a challenge. This project is built with Next.js 13, uses hooks and context to persist state, and is set up with ESLint (Airbnb style), lint-staged, Prettier, and Husky.

Features

• Developed with Next.js 13
• Uses hooks and context to persist state
• Configured with ESLint (Airbnb style), lint-staged, Prettier, and Husky
• Docker and Docker Compose support
• Conventional Commits and Commitizen usage

Live Demo

You can find a live version of the project at this link: https://eclectic-kelpie-73a18e.netlify.app.

Requirements

• Node.js 16.8.0 or newer
• Docker Compose (Optional)

Installation

Clone the repository:

git clone https://github.com/ffigueroa/memorygame.git

Install the dependencies:

With npm:

cd memorygame
npm install

With yarn:

cd memorygame
yarn install

Run the project in development mode:

npm run dev

or

yarn dev

Visit http://localhost:3000 in your browser.

Docker

To run the project with Docker, make sure you have Docker and Docker Compose installed, and follow these steps:

cd memorygame
docker-compose up

To stop and remove the container:

docker-compose down

Visit http://localhost:3000 in your browser.

Conventional Commits and Commitizen

This project follows the Conventional Commits specifications to facilitate changelog generation and improve commit message readability. In addition, Commitizen is used to help contributors follow these conventions.

To make a commit with Commitizen, run the following command instead of git commit:

npm run commit

or

yarn commit

Commitizen will guide you to create a commit message following the Conventional Commits specifications.

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for more details.