Skip to content

Latest commit

 

History

History
69 lines (38 loc) · 2 KB

readme.md

File metadata and controls

69 lines (38 loc) · 2 KB

Build Status

Chip8 Web

A Chip8 emulator which runs in the browser along with tools to view the registers and instructions etc. The live version can be viewed on Heroku here.

Screenshot

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To avoid any versioning issues, we recommend using nvm to manage the version of node and npm used in the project.

Installing

Install the dependencies

npm install

Run the dev server

npm run start:dev

Once the project has finished building, you should be able to view it here: http://localhost:9000

Running the tests

This project uses jest for tests. They can be run with

npm test

Deployment

This project is deployed to Heroky via TravisCI. Any commits to master will be deployed automatically to http://chip8-web.herokuapp.com

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

  • Daniel Tait - Initial work - Taiters

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgements

See also the list of contributors who participated in this project.