🔧 Local setup for development (~20 min)

Documentation not available yet

0️ Prepare your machine

A machine with a recent version of NodeJS is required (see used version in Dockerfile).

Run the following command to clone this repository and install dependencies.

git clone https://github.com/lowlighter/metrics.git
cd metrics/
npm install
cp settings.example.json settings.json

Follow 🏗️ Deploying a web instance (~20 min) guide except docker-related sections.

Once read, start local instance using the following command:

npm start

Connect to your web server using http://localhost:{port} and start hacking!

For quick testing, it is advised to directly craft URLs, rather than using the web interface.

Example: test a new plugin

https://localhost:{port}/username?base=0&newplugin=1&newplugin.option1=hello&newplugin.option2=world)