KnockKnock

This is the repository of the knockknock website.

Requirements

Node.JS 22

The project use the arp -a command. On ubuntu you can install it with sudo apt-get install net-tools

Installation

git clone [email protected]:e-adrien/knockknock.git
cd knockknock
npm install

Configuration

Copy the file in config/config.sample.json to config/config.json and define your own values.

Fix linting errors

To fix ESLint & Stylelint errors run the following commands :

npm run eslint-fix
npm run stylelint-fix

To ensure consistent code style run the following command :

npm run prettier-fix

To check if the project will pass the Github QC Action you can run the command :

npm run qc

Build & run the project

Build the project with the command :

npm run build

and then run the server using :

npm run start

VS Code

Recommended extensions :

• EditorConfig for VS Code
• ESLint
• Stylelint
• Prettier - Code formatter