CONTRIBUTING.md

Contributing

Requirements

• Git
• Docker
• Docker Compose

Clone

git clone https://github.com/aminnairi/kryptonian
cd kryptonian

Setup

cp .env.example .env

Startup

docker compose up --detach

Library

Install

docker compose exec node npm install

Development

docker compose exec node npm run dev

Test

docker compose exec node npm test

Coverage report

docker compose exec node npm run coverage

Build

docker compose exec node npm run build

Template

Install

docker compose exec node npm --workspaces install

Development

docker compose exec node npm --workspace template/shared run dev
docker compose exec node npm --workspace template/server run dev
docker compose exec node npm --workspace template/client run dev

Build

docker compose exec node npm --workspaces run build

Or

docker compose node npm --workspace template/shared run build
docker compose node npm --workspace template/server run build
docker compose node npm --workspace template/client run build

Publish

Setup

Go on npmjs.com and login as a maintainer of the package. Create a publish key and add it to the .npmrc file.

touch .npmrc

//registry.npmjs.org/:_authToken=INSERTAUTHTOKENHERE

Build

docker compose exec node npm run build

Changelog

Add the necessary changelogs in the CHANGELOG.md file for the next release.

Package Version

Update the package version in the package.json file to reflect the new release.

Publish

docker compose exec node npm publish

Shutdown

docker compose down --remove-orphans --volumes --timeout 0