lmisea / en-passant

A friendly chess platform built with react and typescript.

EnPassant

A friendly chess platform built with react and typescript.

Getting started

Prerequisites

• Node.js v20.

Installation

1. Clone the repo.

   git clone https://github.com/lmisea/en-passant.git en-passant
   cd en-passant

2. Enable corepack in Node.js v20 for being able to use yarn v4.

   corepack enable

3. Install dependencies.

   yarn install

4. Run the prepare script for setting up the git hooks.

   yarn prepare

Development

1. Vite.js starts the development server on the localhost.

   yarn dev

2. Start the storybook server.

   yarn storybook

3. For updating the dependencies, run the following command.

   yarn upgrade-interactive

Production

1. Vite.js builds the app into a static site on the dist folder.

   yarn build

2. After building the app, vite.js will also allow you to preview the build on the localhost.

   yarn preview

Attributions

All the attributions are located in the ATTRIBUTIONS.md file.

License

Distributed under the MIT License. See LICENSE.