Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 59 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,61 @@ Built with [Node.js](https://nodejs.org/), [socket.io](https://socket.io/), and

To see this code with [Flow](https://flow.org/) typing, visit the [flow branch](https://github.com/vzhou842/example-.io-game/tree/flow).

## Development
### Table of Contents

To get started, make sure you have Node and NPM installed. Then,
- [Features](#features)
- [Installation](#installation)
- [Tests](#tests)
- [Contribute](#contribute)
- [License](#license)


## Features

- Demonstrate the creation of a sample multiplayer .io game similar to ones such as agar.io
- Javascript implementation with ability to run build of game locally
- Unit tests for verification of functionality

## Installation

To get started, make sure you have the following prerequisits installed:

1. Node
For Windows, use the official installer found at https://nodejs.org/en

For MacOS (using homebrew)
```bash
brew install node
```

2. NVM
For Windows, use the VNM for Windows installer from this [Github Repository](https://github.com/coreybutler/nvm-windows/releases)

For MacOS (using homebrew)
```bash
brew install nvm
```


Then, to run the game on your local machine, run the following commands:

```bash
$ npm install
$ npm run develop
```

on your local machine.
To access and play the example io game, enter

To run the project in a production setting, simply
```bash
http://localhost:3000
```

in your web browser of choice.
By default, the port is set to 3000.
You may change the port to one of your choosing (e.g., 80, 443, etc.) by modifying the file
[server.js](src/server/server.js)

To run the project in a production setting, simply enter the following commands in your terminal:

```bash
$ npm install
Expand All @@ -45,3 +88,15 @@ To run the tests for this this project, simply
$ npm install
$ npm test
```


## Contribute

Source Code: https://github.com/vzhou842/example-.io-game/tree/master/src


## License

This Project is licensed under the MIT License and is Copyright (c) 2019 Victor Zhou.

For more license terms and details, please refer to the [LICENSE](LICENSE).