Team-GoalDiggers

---

Team Members

• Wai To Wong (Wilson)
• Wu Lai Yin (Peter) (44115001)
• Nguyen Duc Hung (Kelvin) (44064499)
• Pei-Shih Chu (Mimi) (44087948)

Documentation and Process Information

Please follow the link to find out more about our documentation and process information: https://github.com/deco3500-2019/Team-GoalDiggers/wiki

Deployment Guide and Usage Instruction

How to install and develope the source code

Prerequisites

• Node.js (including npm)

Download the Repo

Download or clone the repository onto your local system

Install dependencies

Navigate to the local repo inside of a command line interface (terminal, powershell, cmd) first type in npm install

Start development server

1. To run the client side: navigate to the client folder, run npm start
2. To run the server side: navigate to the server folder, run node index.js

Trouble shooting

If there are any errors occurs during the installation please read through:

• React: https://reactjs.org/docs/getting-started.html
• Socket.io: https://socket.io/docs/

For Testing and Using the application

Without modifications to test functionality

In order to test the product without downloading the source code please visit this url: https://5dad1f975aa1feeb765a668e--sleepy-hawking-e58e4b.netlify.com/

Test code developed locally

1. Navigate to client and server folder run npm install
2. To run the client side: navigate to the client folder, run npm start
3. To run the server side: navigate to the server folder, run node index.js

Technology used

React

React was used as the backbone of the application to allow for the app to be built using only javascript whilst still maintating cross platform compatibility.

Socket.io

Socket.io is the main library was used to build the connection between 2 devices, support real-time communication and immediate interact.

Node.js

Node.js was used to build server to run the application and the environment for the server side communicate with the client side