Skip to content

mpgp/Mpgp

Mpgp

https://mpgp.github.io/#/spec/

Multiplayer Game Platform


GitHub version License PRs Welcome

stable Build status CircleCI

Known Vulnerabilities Greenkeeper badge


Prerequisites

  • For local development environment follow these instructions: INSTALL.md
  • For docker environment follow these instructions docker/README.md

Development server

Run yarn run start:dev for a dev server.

Api will available on http://localhost:5000/api/{controller}/{params?}

WebSocket will available on ws://localhost:5000/elite-crew

Run tests

yarn run test:run

Project Structure

.
|-- .circleci/
|-- .github/
|-- .vscode/
|-- artifacts/
|-- docker/
|-- libs/
|-- scripts/
|-- src/
|-- tests/
|-- tools/
|-- .gitignore
|-- .gitattributes
|-- .ToDo
|-- .travis.yml
|-- CHANGELOG.md
|-- INSTALL.md
|-- LICENSE
|-- package.json
|-- README.md
L-- yarn.lock
.github/ - Templates for issues and pull requests.
artifacts/ - HTML pages, SQL scripts, other stuff.
docker/ - Docker images and compose files.
libs/ - Any additional libraries.
scripts/ - Any additional scripts.
src/ - Source code.
tests/ - Project tests.
tools/ - Any additional tools like a appsettings.json, nlog.config, etc.
.ToDo - Any general to do items.
.travis.yml - Travis Ci file.
CHANGELOG.md - All notable changes to this project will be documented in this file.
INSTALL.md - How to build, install, compile, how to do database migrations.
LICENSE - BSD 2-Clause "Simplified" License
package.json - Npm dependencies and configurations.
README.md - Info about the project.
yarn.lock - Current packages version.

Repository Structure was designed by Saritasa team.