Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 1.91 KB

README.md

File metadata and controls

65 lines (48 loc) · 1.91 KB
Raw

HQ_Game

License: MIT

This code has been used in part of my project manamo.app which provides an online HQ game for many of the users who learn English from Manamo consistently, this part of the Manamo had lots of challenges for me therefore I decided to share that with you and I'm hopeful that would be useful.

So here I will share my experience along with a sample code that will demonstrate how to create an HQ online game with Node.js along with MySql and Redis. and also I provided a "manage" route with REST API methods to manage the game through API Requests.

I consider this code is a sample and you should implement users authentication and users table by yourself base on JWT or Oauth2. Please notice that I used PM2 to run Node.js on CentOS server but you can use alternative options.

Built With

  • Node.js
  • Express.js
  • Socket.io
  • MySql
  • Redis

Packages Used

  • Promise - Handle the result of an asynchronous task
  • Sequelize - Object Relational Mapper
  • Sequelize-redis-cache - Cache MySql tables in Redis
  • EventEmitter - Handle custom events module
  • Express-validator - Validator and sanitizer functions
  • Socket.io-redis - Adapter to enable broadcasting events
  • Apidoc - API documantation

Prerequisite

  • node & npm
  • MySql
  • Redis
  • pm2

Installation

npm install

Install pm2 globally

npm install pm2 -g

Setup MySql and Redis

You should create MySql tables base on (/models/files) then set your MySql and Redis configration in (/config/config.json)

Start application

NODE_ENV=production PORT=[your preference port] pm2 start /bin/www --name "HQ_Game" --max-memory-restart [your preference memory]

Contributing

All contributions welcome.

Credits

License

The MIT License (MIT)