Altzone-Server
This is a REST API for the Altzone game. For API description see the wiki pages
Releases
Link to the API
Production https://altzone.fi/api (prod branch) Latest release https://devapi.altzone.fi/latest-release (main branch) Dev https://devapi.altzone.fi (dev branch)
Swagger description
-
Latest swagger file version The most up-to-date API description
Wiki pages quick access
Client side docs (game and webpages teams):
General info
Authentication and authorization
Data fetching (GET requests)
API developers pages:
Development process
Branches
JSDocs
Tests
Pull request check list
Documentation
Files that should not be modified
What to do if
Getting started
Install required software
- Install Node and npm, choose your platform and node version, which should be LTS Download here
- Install docker Instructions here
- Clone the API repo from GitHub Link to repo
- Open cloned repo in IDE and install required dependencies with
npm install
Start DB
Run docker compose up to start DB, mongo-express (UI for Mongo) and Nginx (it will take couple minutes for the first time)
Start the API
Start the API in dev (watch) mode by running npm run start:dev in a new terminal.
This command will compile TS to JS and create a dist folder. This folder should not be removed.
The server will be accessible on your machine on http://localhost:8080/
Stop API and DB
- Stop API by pressing Ctrl+C in terminal
- Stop DB and all other Docker services by pressing Ctrl+C (mb couple times) and run
docker compose down
DB Schema
API architecture schema
