Zuruuh / game-on

Code du projet 4 de développeur front-end V2
0 stars 0 forks source link

Game On

Usage

Installation

To setup the project locally, you need to meet the following requirements:

Once everything is installed, you can clone the project locally with the following command:

git clone git@github.com:Zuruuh/game-on
cd game-on

Then, install all the npm dependencies with pnpm install.

Development

To run the project locally, use the npm script dev with pnpm run dev, and the project will be served locally at http://localhost:5173. You will benefit from ViteJS Hot Module Replacement which will update all your code directly in your browser when you edit it.

Testing

Playwright is used to test the website's features. To set it up locally, try to run the command pnpm run playwright:install. If you receive an error message telling you that your os is not supported you can use the docker alternative by running pnpm run docker:build.

Once the installation step is done, simply run pnpm run playwright:test (or pnpm run docker:test if you are using docker) and everything should be good to go!

Production

To build the project for production, simply run pnpm run build and you will get your prod-ready project in the ./dist folder.

Tools

This project has multiple tools setup by default, let's take a look at all of them 🚀