https://github.com/github/pac-tocat
PacMan game starring the lovable GitHub octocat mascot
https://github.com/github/pac-tocat
Last synced: 5 months ago
JSON representation
PacMan game starring the lovable GitHub octocat mascot
- Host: GitHub
- URL: https://github.com/github/pac-tocat
- Owner: github
- License: mit
- Fork: true (bward2/pacman-js)
- Created: 2022-10-12T17:42:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T04:14:36.000Z (over 1 year ago)
- Last Synced: 2024-09-30T00:20:18.501Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 3.24 MB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pac-tocat
[](https://github.com/airbnb/javascript)
🕹Play Pac-Man starring [Mona](https://github.com/monatheoctocat), the loveable GitHub octocat mascot using Javascript, HTML, and CSS.
🙌 Forked from [bward2/pacman-js](https://github.com/bward2/pacman-js)
When opening the project in a codespace with supported editors, the project will be run by default via the [devcontainer's postAttach commands](https://github.com/github/Pac-tocat/blob/master/.devcontainer/devcontainer.json#L16).
## Local 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. `npx 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! 😃