CONTRIBUTING.md

Contributing to BundleMon

Thanks for taking the time to contribute! ❤️

Local development

Prerequisites

• Node.js >= v18
• Yarn

Install dependencies

yarn install

Build packages

yarn build-packages

BundleMon CLI

Test packages

yarn test-packages

BundleMon Service

Requires docker & docker compose

Start service

When changing code in apps/service/ directory the service will reload itself

Run from apps/service/ directory

yarn serve

By default the service will start on port 3333

Generate local data

The script will generate 3 projects, run it when the local service is running

yarn gen-local-data

Run tests

Run from apps/service/ directory

yarn start:mock-services

yarn test

BundleMon website

yarn serve

After running the command the website will be available at https://localhost:4000/

By default the local website will expect a local BundleMon service on port 3333.