Skip to content

readme.md

Latest commit

 

History

History
40 lines (26 loc) · 1.04 KB

readme.md

File metadata and controls

40 lines (26 loc) · 1.04 KB
Raw

🌵 Arkavidia Monopoly Backend

ESLint Badge Build and Deploy Badge

Prerequisites

NodeJS, developed under v14.15.0 (LTS).

Running

Install required dependencies:

yarn

Run the project in development mode:

yarn dev

Or preferably, run it in production mode:

yarn start

Scripts

The scripts inside package.json are listed in detail inside the package-scripts.js file. This project uses the nps package to manage the scripts.

Documentation

The complete documentation for the REST API will be available at the endpoint /docs. The websocket API documentation will be announced in a further notice.

Using the API

Example: GET http://localhost:3000/api/player (Returns all listed players)