Skip to content

Latest commit

 

History

History
36 lines (20 loc) · 2.84 KB

README.md

File metadata and controls

36 lines (20 loc) · 2.84 KB
Raw

asp8_TowerDefense

A Tower Defense game for Agile Software Programming Group 8

Developer Setup

Because of the nature of Phaser, and writing games with JavaScript, the game will need a web server to be able to be tested during development. There are a few tools that can be used to help streamline this process. Brackets and Visual Studio Code both have the ability to run a local web server for easy testing of the game. This project can also make use of NodeJS to run a small local web server.

NodeJS

Install the current LTS version of NodeJS from here (16.13.2 at time of writing). Once node is installed, through a command prompt, navigate to the projects root directory and run npm install to install all of the NodeJS Dependencies.

Note: This step is only required to run either a local web server, or, to run the tests through Mocha. NodeJS is not required to run, or develop the game project.

HTTP-Server

With a command prompt in the projects root directory, run npm run server. This will launch a local web server for the project. In a web browser, you will be able to navigate to http://127.0.0.1:8080/ to play the game locally.

IDEs

Both Brackets and Visual Studio Code make excellent code editors for JavaScript and both have the ability to run a test web server in the background for easy testing during development.

Brackets

Brackets can be used for development. It is a great cross platform IDE and it has Live Preview built in by default. It can be downloaded here.

Visual Studio Code

Visual Studio Code is an excellent, cross platform IDE which has many extensions which can help with development. It does not have a Live Preview feature built in, but does have the ability to add one through the use of Extensions. VSCode can be downloaded from here and is regularly updated. For easy development, I recommend installing a few extensions.

  1. Live Server - This extension will add the ability to right click an HTML file in the project and launch the live server. This will run the server in the background and allow for easy testing in the Browser.
  2. Debugger For Chrome - This will add a full debugger which will allow you to easily debug your code while it is running inside of Chrome.
  3. Mocha - Mocha extension allows for running Mocha tests in Visual Studio Code

Tests

Tests will be run using MochaJS. The package will be installed automatically the the NodeJS required modules. To run the tests type npm run test. All tests will ne located in the ./test folder.