https://github.com/githubjakob/breakfree
simple jump'n'run using Phaser with a NodeJs Backend, developed as part of a computer science course
https://github.com/githubjakob/breakfree
Last synced: about 1 year ago
JSON representation
simple jump'n'run using Phaser with a NodeJs Backend, developed as part of a computer science course
- Host: GitHub
- URL: https://github.com/githubjakob/breakfree
- Owner: githubjakob
- Created: 2018-01-17T15:05:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-17T15:34:18.000Z (over 8 years ago)
- Last Synced: 2025-02-16T20:28:27.522Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 6.11 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Break free (student project)
The game was developed in 2017 by five students as part of a computer science course at LMU Munich, see the [course page](http://www.pms.ifi.lmu.de/lehre/praktikum/progprakt/17ss/).
The game makes use of the [Phaser framework](https://phaser.io/) and features a NodeJS backend with a MongodDb to save/load the current game state. The game can be build as a Docker image and was hosted on AWS EC2 for the final präsentation of the project.
## How to run
Quickly start up the NodeJS using docker compose:
1. Clone the project from GitHub
2. Switch to project's directory and build project
```
docker build -t breakfree:latest .
```
3. Startup the docker images
```
docker-compose up
```
4. Browse
[localhost:8080](localhost:8080)
## Used Technologies
- JavaScript (ECMAScript 6)
- Phaser
- NodeJs
- MongoDB
- Docker
## Dependencies
Server dependencies, install with `npm install`
- express: 4.15.2
- mongodb: 2.2.26
- socket.io: 1.7.4
- mongoose: 4.9.8
- winston: 2.3.1
Client dependencies, stored in `client/javascript/lib`
- Phaser
- Logger: 1.3.0
- Jquery: 3.2.1
- Phaser Illuminated
- Illuminated
## Slides
Slides of the [final präsentation](https://docs.google.com/presentation/d/1qO8Ctf0PK-kNqtzp0Idy-s3wpD_E1Fv-7NEx1x65fbU/edit#slide=id.p) of the project.