Commit 8d5bbfab authored by Rémi Garde's avatar Rémi Garde

Update README

parent fb3546d9
......@@ -5,16 +5,22 @@ Try it at https://pooker.ml or https://18.223.33.251/ !
# Installation
Assuming Git, Python3 and pip are installed on a Linux-like system (switching to another OS should be similar):
``` bash
git clone https://gitlab.centralesupelec.fr/2015garder/POOker.git
cd POOker/
python3 -m pip install --user -r requirements.txt
```
Launch the server:
Launch the server locally:
``` bash
env FLASK_ENV=development FLASK_APP=server/server.py python3 -m flask run -p 5000
```
Then access it at http://localhost:5000.
To serve in production mode, `FLASK_ENV=production` should be used.
If served on the World Wide Web behind a reverse proxy, please note that you also need to forward the websocket connections.
# Usage
Connect to the webpage, choose the game mode :
......@@ -49,7 +55,7 @@ Detailed file description:
- `hand.py`: describe the poker hands formed by the `Cards`.
- `front/`
- `static/`: the static CCS/JS/Images files - inspired by https://github.com/tansey/js_poker
- `templates`: the Jinja2 HTML templates used by Flask
- `templates/`: the Jinja2 HTML templates used by Flask
# Known problems
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment