ild-games/Skein

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Skein
![](https://api.travis-ci.org/ild-games/Skein.svg?branch=develop)
[![Test Coverage](https://api.codeclimate.com/v1/badges/fb60bbf3019af519fa80/test_coverage)](https://codeclimate.com/github/ild-games/Skein/test_coverage)

## About

Skein is an interactive editor for the Yarn Dialogue language.

More information about Yarn can be found at the [Yarn github page](https://github.com/InfiniteAmmoInc/Yarn)


## Setup Instructions

[Yarn](https://yarnpkg.com/en/) is the preferred node package manager for Skein. We check in the yarn.lock file instead of the npm lock file. The following yarn commands can be replaced with the appropriate npm commands if desired.

### Installing Dependencies
1. Install yarn
2. Install project dependencies `yarn`

### Running from Command Line

`yarn run start`

### Running Unit Tests

`yarn run test`

### Running E2E Tests

`yarn run e2e`

### Running linter

`yarn run lint`