getting_started_guide.md

Getting Started Guidelines

This document steps through the deployment and configuration of RaccoonChessSigma

Prerequisites

The following are prerequisites for building and deploying:

• TypeScript >= 3.2 - JavaScript that scales. We need at least version
• Jest - Delightful JavaScript Testing
• ts-jest - Jest processor for TypeScript

Either nodejs >= 13.x or yarn is need for developing this project. When either package manager has been installed, the above requirements can be installed by running either of the following:

	command
npm	npm i -D typescript ts-loader webpack-cli webpack jest ts-jest @types/jest eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-sonarjs @types/node
yarn	yarn add -D typescript ts-loader webpack-cli webpack jest ts-jest @types/jest eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-sonarjs @types/node

Building & Using RaccoonChessSigma

RaccoonChessSigma can be built and used as a UCI-compliant Chess Engine or as an extensive JavaScript Chess Library. If the perquisites have been installed, from the root directory where the repo was cloned, the execute:

JavaScript Chess Library

	npm	yarn
Build	npm run build:api	yarn build:api

The above script will create raccoon.api.js in /build. See Usage for more info.

UCI-compliant Chess Engine

raccoon

Build	npm	yarn	output
NodeJS & Web Worker	npm run build:uci	yarn build:uci	raccoon.uci.js

The above script will create the output in /build folder. See Usage for more info.

Testing RaccoonChessSigma

Assuming the perquisites have been installed, from the root directory where the repo was cloned, the unit tests and coverage can be executed as follows:

	npm	yarn
Unit Test	npm run test	yarn test
Coverage	npm run coverage	yarn coverage