https://github.com/drearondov/scrabblescoreboard
Rest API to collect Scrabble games data
https://github.com/drearondov/scrabblescoreboard
flask flask-restful flask-sqlalchemy python
Last synced: about 2 months ago
JSON representation
Rest API to collect Scrabble games data
- Host: GitHub
- URL: https://github.com/drearondov/scrabblescoreboard
- Owner: drearondov
- License: gpl-3.0
- Created: 2020-12-14T00:18:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-04T23:03:07.000Z (over 2 years ago)
- Last Synced: 2025-10-07T12:35:32.638Z (9 months ago)
- Topics: flask, flask-restful, flask-sqlalchemy, python
- Language: Python
- Homepage:
- Size: 1.06 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Scrabble Scoreboard


Collect data about Scrabble Games and marvel or cry at the sight of your vocabulary and resourcefulness.
## Endpoints
* `GET /words` - Retrieves a list of all words in dictionary
* `GET /words/languages` - Retrieves a list of all words in a specific language
* `POST /games` - Creates a new game
* `PUT /games` - Edits a game
* `DELETE /games/` - Deletes a game
* `GET /games//plays` - Gets all the plays from a game
* `GET /players` - Gets all players
* `POST /players` - Creates a new player
* `PUT /players/` - Updates a player based on its id
* `DELETE /players/` - Deletes a player
* `GET players//plays`
* `GET /plays`- Retrieves a list of plays
* `GET /plays/` - Retrieves info about a play
* `POST /plays` - Creates a new play
* `PUT /plays/` - Updates a play based on its id
* `DELETE /plays/` - Deletes a play based on its id
## Resources
* [PostgreSQL](https://www.postgresql.org): Popular and extensible database server.
* [Flask](https://flask.palletsprojects.com/en/1.1.x/): Microframework to create the web application.
* [Flask-SQLAlchemy](https://flask-sqlalchemy.palletsprojects.com/en/2.x/) and [Flask-Migrate](https://flask-migrate.readthedocs.io/en/latest/): Packages used for database management.
* [Flask-Marshmallow](https://flask-marshmallow.readthedocs.io/en/latest/): Package used for serialization and data validation
* [Flask-restful](https://flask-restful.readthedocs.io/en/latest/): Packages used to create the endpoints
* [Flask-JWT-Extended](https://flask-jwt-extended.readthedocs.io/en/latest/): Token based authentication
## Acknowledgements
* [cookiecutter-flask-restful](https://github.com/karec/cookiecutter-flask-restful) by karec: Cookiecutter used to start the project, a very complete template