Codenames common library

This repository contains TypeScript interfaces for the Codenames application, for use by both frontend and backend projects.

Install

npm i -S @manwaring-games/codenames-common

Local development

Local setup prerequisites

1. CircleCI CLI: This project uses CircleCI for CI and publishing, and contains a Git hook (managed by husky) to validate the CircleCI config before committing. For you to commit changes you'll need to install the CLI.
2. Nodejs: I recommend using nvm or something similar to manage Node versions locally. This project is developed and tested on the lts version, which as of inital package publishing is 12.16.3.

Steps to publish

1. Commit changes locally
2. Update package version (using semantic versioning) with the npm version <version> command and commit the updated package.json and package-lock.json files
3. Push all changes to GitHub
4. *Create a new release in GitHub matching the new package version, prefixed with a v e.g. v0.0.1

*Note that commiting to the main branch will trigger CI checks in CircleCI but won't initiate package publishing - only the creation of a new release in GitHub will initiate the CircleCI workflow to publish a new package.