Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.22 KB

getting-started.md

File metadata and controls

43 lines (32 loc) · 1.22 KB
Raw
id title
bsk:getting-started
Getting Started ∙ actions-interactor

Getting Started

For better experience, make sure that you have npm v3+ installed. Start by cloning this repo and installing project dependencies:

$ git clone -o actions-interactor \
      -b master --single-branch \
      https://github.com/AdrienEtienne/actions-interactor.git \
      <your-project-name>
$ cd <your-project-name>
$ npm install

How to Build

Running npm run build will compile source files to a distributable format (CommonJS, ES6 and UMD) ready to be published to NPM from the dist folder. See tools/build.js for more info.

How to Test

Run one, or a combination of the following commands to lint and test your code:

  • npm run lint — lint the source code with ESLint
  • npm test — run unit tests with Mocha
  • npm run test:watch — run unit tests with Mocha, and watch files for changes
  • npm run test:cover — run unit tests with code coverage by Istanbul

How to Update

Down the road you can fetch and merge the recent changes from this repo back into your project:

$ git checkout master
$ git fetch actions-interactor
$ git merge actions-interactor/master
$ npm install