-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,21 @@ | ||
# pacman-js | ||
[![Build Status](https://travis-ci.com/bward2/pacman-js.svg?branch=master)](https://travis-ci.com/bward2/pacman-js) | ||
[![Coverage Status](https://coveralls.io/repos/github/bward2/pacman-js/badge.svg?branch=master)](https://coveralls.io/github/bward2/pacman-js?branch=master) | ||
[![Code Style](https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg)](https://github.com/airbnb/javascript) | ||
|
||
Pacman clone made with Javascript and HTML - *__[Play it!](https://bward2.github.io/pacman-js/)__* | ||
|
||
ππππππΎππ | ||
|
||
## Development Instructions | ||
|
||
This project makes use of *__[NodeJS](https://nodejs.org/en/)__*. Download it, then clone this repo and run the following commands: | ||
1. `npm i` (Installs necessary packages for development) | ||
1. `gulp watch` (Watches changes to JS and SCSS files for continuous compilation) | ||
1. `npm run serve` (Hosts the files locally) | ||
|
||
The game can now be accessed at *__http://127.0.0.1:8080/index__* | ||
|
||
This project also utilizes *__[Husky](https://github.com/typicode/husky)__* to enforce best coding practices. The current thresholds are 0 linting errors upon commits (following Airbnb's standard), and 100% unit test code coverage upon pushes. | ||
|
||
Feel free to submit PRs and/or report any issues you find! π |