patillacode / kuevassonne

Carcassonne Statistics Website

Kuevassonne

A personal Carcassonne game tracker website

Idea

We needed something better than the good old excel file to keep track of our Carcassonne games (yes, we get very competitive)
Something that would make setting up a game fast, something that would let you choose the players, assign colors, select expansions, check win rates, see pictures... Basically a nice little web app
This is it!

Execution

I decided to give it a go with a Django project, Python is my pocket pick when it comes to programming languages and Django allows me to set the thing up as fast as it comes. Postgresql for the DB side of things and I have a home server where I host these little projects I do (docker & nginx do the trick)

Set up

I assume you have a postgresql db server running somewhere

You can just:

# clone the repo
git clone [e-mail]:patillacode/relatos-a-medida.git

# go into the project folder
cd kuevassonne

# run the install command
make install

# migrate and generate statics
make statics-and-migrations

Or if you prefer to do things step by step, knowingly:

# clone the repo
git clone [e-mail]:patillacode/kuevassonne.git

# go into the project folder
cd kuevassonne

# create a virtual environment (venv)
python3 -m venv venv

# activate the venv
source venv/bin/activate

# upgrade the pip tool
pip install --upgrade pip

# install requirements
pip install -r requirements.txt

# run the Django command to set your statics
python manage.py collectstatic

# and the migrations
python manage.py migrate

Run it

# this should make the app accessible under http://localhost:8000
python manage.py runserver

Only if developing CSS

# if you are developing you need to run the following in another terminal
# this will keep compiling website/static/css/styles.css into website/static/css/dist.css
# after each change in styles.css for your benefit
make create-styles-dev

Docker

Check the Docker README