1.1.0 ā¢ Published 3 years ago
@klifu/core v1.1.0
Under Development šØ
Table of Contents
Overview
Core is the library that contains the game logic for klifu. We aim to make this library standalone so anyone can use it to build any client for klifu.
Installation
To run this library ensure that you have Node.js >= v10 Install Node.js via package manager
To install
npm install @klifu/core
Contributing
šš First off, thanks for taking the time to contribute! šš
For instructions to start contributing check out Klifu.
Development Environment Setup
To setup you local development environment for contribution follow these steps bellow -
- Before contribution Fork this repo.
- Clone your forked version in your local computer.
- Install dependencies, run
npm install
. - Check if all tests are running to ensure correct setup, run
npm run test
. - When you are ready to submit your code open a PR.
Documentation
Detailed documentation coming soon.