curdle

A cheesy word game built to demonstrate Django REST Framework and Redux code generation

Requirements

• Python 3.10
• Pipenv
• Node.js 18.8.0
• npm 8.19.1

Setup

Check out the repository

git clone https://github.com/midouest/curdle.git
cd curdle

Install Python dependencies

pipenv install --dev
pipenv shell

Initialize Django database

python manage.py migrate
python manage.py createsuperuser
python manage.py load_words data/answers.txt data/guesses.txt

Install JavaScript dependencies

cd web
npm install

Launch

Backend

python manage.py runserver 8000

Open http://localhost:8000/docs/ to view the OpenAPI schema

Frontend

cd web
npm start

Open http://localhost:3000 to view the app

Common Development Tasks

Code Generation

To regenerate the OpenAPI schema and Redux API slice, run the codegen script in the root of the repository:

./scripts/codegen.sh

Reset Game Data

To clear all game data and reload the word database, run the reset script in the root of the repository:

./scripts/reset.sh