Endless Kingdom

Bievenue sur le git d'EndlessKingdom !

Table des matières

1. Lancer le serveur en local
2. Contribuer au jeu

Lancer le serveur en local

Pour lancer le serveur en local, il y a plusieurs moyens.

Docker

La première solution (et la plus simple) est d'utiliser docker, ainsi que le script docker-compose. Il suffit alors de lancer la commande :

docker-compose up

En rajoutant l'option -d pour lancer le service en arrière plan.

Pour y accéder, ouvrez votre naviguateur et taper l'adresse 0.0.0.0:3000

Node

Pour lancer sans docker et juste avec node, il vous faut plusieurs logiciels :

• node.js
• mongoDB
• un navigateur web

Bien sûr il vous faut aussi une version de ce code (téléchargement ou git clone).

Pour commencer, lancer le serveur mongodb. (La procédure est expliquée dans la documentation de mongodb, mais si vous l'avez installé sous windows, vous devriez lancer mongod.exe qui se trouve dans le répertoire d'installation de mongodb. Si ce dernier ne se lance pas, essayer de créer le dossier /data/db à la racine de votre disque dur).

Ensuite, lancer node en command prompt, et déplacer vous dans le répertoire d'Endless Kingdom. Effectuer la commande : npm install pour installer les dépendances du projet.

Finalement, effectuer la commande node app.js. Votre serveur local est lancé !

Pour y accéder, ouvrez votre navigateur et taper l'adresse localhost.

Contribuer au jeu

Pour contribuer au jeu, ouvrez une branche sur le git. Quand vos modifications seront terminées, pusher-les, et faites une demande de merge. Un administrateur du projet pourra vous merge si votre travail est convenable !