Skip to content

Fifth-Aeon/Fifth-Aeon-Server

Repository files navigation

About

This is a server for a collectable card game written in typescript. You can find a corresponding client at https://github.com/WilliamRitson/CCG-Client. The game's core logic is shared between the client and the server. To facilitate this sharing it uses a git submodule which is hosted at https://github.com/WilliamRitson/CCG-Model.

Install

Run git clone --recursive https://github.com/WilliamRitson/CCG-Server.git to clone the project and its submodule (do this wherever you want the project stored on your computer).

Install node using an installer. This should also install npm.

Run npm install -g gulp to get gulp which is used to compile the projects TypeScript into JavaScript.

Run npm install within the project directory (the place you cloned it) to install the project's dependencies.

Install postgres.

Set the PGUSER enviroment variable to the user for the postgress database and the PGDATABASE to the database on the server which the applicaiton should use.

If you want email support set the SENDGRID_API_KEY enviroment variable.

Run

You can use gulp watch to automatically compile typescript.

You can use npm start to start the server (once typescript has been compiled).

In order to run a game, you to start at least a server and two clients. Run the join command from each client.

About

An NodeJS server for the Fifth Aeon collectable card game.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published