Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 2.82 KB

README.md

File metadata and controls

49 lines (27 loc) · 2.82 KB

GAEmes

GAEmes is a simple web database built on top of Google App Engine (the 'GAE' in GAEmes). It is designed as a quick, easy, and free way to publish a list of board games that can be queried based on number of players and amount of game time.

Note: GAEmes is intended for small to medium collections (20-500 titles). Collections larger than 1000 titles may be difficult to import and will quickly exceed the free tier of Google App Engine.

History

GAEmes was born out of a practical problem. I have intimate knowledge of the games in my collection but others don't. When hosting games nights time is always wasted trying to determine what games are playable in the time remaining and with the players present. GAEmes allows anyone to load up the database and query for titles that meet those criteria. It was originally built as a mysql database with a php/html front end but I got tired of having to maintain the equipment it ran on.

Prerequisites

  1. A Google account
  2. A computer that will run the Google App Engine Python SDK (Linux, Mac OS X, Windows)

Setup

Deploying to Google App Engine is free given your app doesn't exceed the daily quota. GAEmes is trivially small and I don't expect you'll encounter quota issues. However, I recommend you do not set your app up with a billing account. This way there is no chance you'll be charged should there be an extreme influx of traffic.

  1. Clone or Download the GAEmes github repo
  2. Download the Python SDK
  3. Create a Google Cloud application and deploy GAEmes.

Usage

There are two main components to GAEmes.

Landing page: This page is publicly viewable. It initially displays the full contents of your collection and offers the ability to filter by amount of time and player count.

Admin page: This page is accessible only to administrators of the app by appending 'admin' to the base URL (e.g. mycoolapp.appspot.com/admin). This is where you can easily add items to your collection. You can also import a collection from BoardGameGeek via this page.

Example

You can view my personal collection at games.mattjriley.com.

License

GAEmes is released under the MIT license. See the LICENSE file for full details.

Contact

Subscribe to [email protected] for updates and news.

Subscribe to [email protected] for general discussion.

E-mail [email protected] for dev-specific queries.