Skip to content

ben-pearce/property-tycoon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

property-tycoon

Property Tycoon written in JavaScript

Setup

First, make sure you have both NodeJS and npm installed on your machine.

On Ubuntu/Debian

$ apt install nodejs npm

On MacOS

If you use homebrew:

$ brew install node

If you don't use homebrew, use the NodeJS installer.

On Windows 10

Use the installer.

Next, clone or download the repository.

$ git clone https://github.com/ketnipz/property-tycoon

Extract, navigate to location of repo and run npm install to get the dependencies.

$ cd /path/to/PropertyTycoon
$ npm install

To test the game, run npm start (Auto-opens in browser).

To build the game, run npm run build.

Documentation

To build the docs for this project, you just need JSDoc.

$ npm i -g jsdoc
$ jsdoc -r -d docs src