wordle-collab

API for Online Collaborative Wordle
using Django Rest Framework and WebSockets

Looking for front-end? https://github.com/douglasedurocha/wordle-collab-Frontend

Clone this project

> git clone https://github.com/douglasedurocha/wordle-collab.git
> cd wordle-collab

Dependencies:

• Poetry : a tool for dependency management and packaging in Python.
• Docker : a containerization platform for building, packaging, and distributing applications.
• Docker Compose : a tool for defining and running multi-container Docker applications.

Usage (development)

Copy .env file

> cp .env.example .env

Start Postgres and Redis service

> make up-dependencies-only

Install the projects requirements, apply the migrations and set up the git hook scripts

> make update

Start server

> make runserver

API

Auth Endpoints

POST  /api/v1/accounts/register
POST  /api/v1/accounts/login
POST  /api/v1/accounts/logout
GET   /api/v1/accounts/user

Wordle Endpoints

GET   /api/v1/games
POST  /api/v1/games
GET   /api/v1/games/<int:game_id>
GET   /api/v1/games/<int:game_id>/attempts

Full API docs https://app.swaggerhub.com/templates-docs/DOUGLASEDUROCHA/wordlecollab/1.0.0

Copyright Notice

This work incorporates words_dictionary.json in words_list.json file, obtained from https://github.com/dwyl/english-words/blob/master/words_dictionary.json.

Copyright (c) 2017-2023, Do What You Love https://github.com/dwyl