Gold Rush Server

A Game Gold Rush - this repo is the server-side with nestjs.


View Demo · Report Bug

Content

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. File Hierarchy
4. Acknowledgements

About The Project

This Repository is server-side, here we can find the logic that controls the game with WebSocket.

Built With

• Nest.js
• nestjs/websockets
• PathFinding.js

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

If you want to control the project from nest.js cli I suggest you install nest.js first:

• npm

  npm i -g @nestjs/cli

Installation

1. Clone the repo

   git clone https://github.com/tomeraitz/gold-rush-server.git

2. Install NPM packages

   npm install

3. Run It on localhost with client repository(8000)

   npm run start:dev 

Note! This project won't do a lot without the client side.

4. Run It on localhost with test environment(8000)

   npm run start:debug 

Note! This is only a simple UI to check if the functions work.

File Hierarchy

src

• main.ts - Activate the server
• app.modules.ts - Import all the main modules.
• app.controller.ts - The default get request.
• single-player
  • single-player.gateway.ts - The script that Activates the WebSocket.
  • single-player.modules.ts - Import the game module.
• gold-rush-game
  • gold-rush-game-logic.service.ts - Inside it's all the computer calculation movement.
  • gold-rush-game.controller.ts - This script receives and gives back data from WebSocket.
  • gold-rush-game.module.ts - Import the game module and websocket module.
  • gold-rush-game.service.ts - This script is handled with all the user inputs and creates the game data.

Acknowledgements

• The project live at Heroku
• The Read me file was created with the template Best-README-Template