Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 1.78 KB

README.md

File metadata and controls

72 lines (48 loc) · 1.78 KB
Raw

mr-flap-js

Build Status codecov

Game 'Mr Flap' written in plain javascript. Available as embeddable library.

Screencast gif

Installation

Use the latest bundled version, a specific release or simply create your own bundle:

$ npm run build

Simply integrate the js and css source files inside your HTML document:

<!DOCTYPE html>
<html>
    <head>
        <link rel="stylesheet" href="./mrflap.min.css">

        <script type="text/javascript" src="./mrflap.min.js"></script>
    </head>

    <body>

        <div class="mrflap-playground"></div>

    </body>
</html>

Make sure the mrflap-playground element is available to render the game inside.

Development

$ npm i
$ npm run dev

Testing

$ npm run test

Commit Message Guidelines

  • feat(new feature for the user, not a new feature for build script)
  • fix(bug fix for the user, not a fix to a build script)
  • docs(changes to the documentation)
  • style(changes to css, styling, etc; no business logic change)
  • refactor(refactoring production code, eg. renaming a variable)
  • test(adding missing tests, refactoring tests; no production code change)
  • chore(updating gulp tasks etc; no production code change)

Definition of Done

See our Definition of Done.

Releasing

We use np for releasing new versions

$ npm i -g np
$ np