An app for recording how badly my wife is beating me in our Gin Rummy matches. Backend is built using the Django REST Framework. Frontend is built using JavaScript.
To install on a new machine:
- Create a virtual environment (
python3 -m venv env
) - Install required dependencies (
python3 -m pip install -r requirements.txt
) - Migrate (
python3 manage.py migrate
) - Create a
.env
file at the root level and add aSECRET_KEY
to it (you can get one by entering into your terminalpython3 -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())"
)
To run the project on your machine, enter python3 manage.py runserver
in your terminal.
To run the testing suite, enter pytest
in your terminal.
The project consists of four primary apps:
accounts
: Contains the defaultuser
model, which we have namedPlayer
.base
: Contains the primary models for the project (Match
,Game
,Score
,Outcome
), as well as signals and validators managing model instance creation.api
: A Django REST Framework API that serves up data frombase
, primarily through theviews.py
andserializers.py
modules. Theurls.py
module contains all API endpoints.frontend
: Views, templates, and scripts written in Django and JavaScript that manage the presentation of data. Theurls.py
module contains all user-facing URLs.
The MIT License (MIT). Copyright © 2022 Jeff Martin. See LICENSE
file for full license.