From 04f9cf4e6992625c1a8b2e001cc770f84fd7eee0 Mon Sep 17 00:00:00 2001 From: Joffrey Bion Date: Thu, 10 Sep 2020 18:28:28 +0200 Subject: Add instructions for running a local server --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a70b0fd7..a37f17e1 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,24 @@ A digital version of the [7 Wonders board game](https://en.wikipedia.org/wiki/7_ > :warning: **DISCLAIMER:** We do not own the rights on the 7 Wonders game concept and rules, > nor on the assets used here. This is a pet project, not intended to be sold. -## :construction: Work in progress +## Try it! A staging version of the app is running [on heroku](https://seven-wonders-online.herokuapp.com/). Heroku's free plan shuts down servers when not used for 30 minutes, so please allow for a bit of delay (~30s) if you're trying it on a cold start. -It is still under development, so the staging server is unstable as the CI/CD pipeline deploys the new app on -it after every successful build of the master branch. +:construction: It is still under development, so the staging server is unstable as the CI/CD pipeline deploys the + new app on it after every successful build of the master branch. It is therefore possible that you experience a server restart if I just pushed some new changes. +#### Locally + +You can also run the server on your own machine by running: + +``` +docker run -p 80:80 ghcr.io/joffrey-bion/seven-wonders-server:latest +``` + ## Technicalities This project is written 100% in Kotlin. You can find the history of the technical decisions in the -- cgit