Skip to content

An open source clone of Geoguessr that can be hosted serverless for free in your AWS account

Notifications You must be signed in to change notification settings

gsx95/georgguessr

Repository files navigation


GeorgGuessr

An open source clone of Geoguessr for you to use.

Key FeaturesHow To UseDevelopmentLicense

Demo

Disclaimer

This project is work in progress. Feel free to open an issue if you encounter any bugs.

Key Features

  • Play Alone or with friends
    • 1 to 10 players
    • set time limit from 30s to 20m or no time limit at all
  • Play in your favorite places
    • Search for places
    • draw custom play areas
    • play in your country or continent
    • just play randomly in the whole world

  • Overview of all player's picks after each round
    • see which locations your friends picked and how far they were off

  • Various options for streetview (TODO)
    • show street names?
    • show compass?
    • building information on mini map?
  • No login required
    • Share games and invite friends with a simple link
  • Easy and cheap hosting in AWS
    • Easy: Fully serverless - uses AWS SAM to deploy the backend lambdas and the static HTML files for the frontend
    • Cheap: Uses AWS Lambda, API Gateway, DynamoDB for cheap hosting (first ~50k games per month fall into the AWS free tier)

How to build

To clone and run this application, you'll need npm, AWS SAM CLI, zip and GoLang >1.16 installed on your computer.

Deploy to AWS

From your command line:

# Clone this repository
$ git clone [email protected]:gsx95/georgguessr.git

# Go into the repository
$ cd georgguessr

# Build and deploy to your AWS account. Use 'guided' target the first time to configure your deployment options.
# If you opted to save your config to a file, just use 'make remote' in the future.
$ make guided

Deploy locally

For developing and debugging purposes, you can spin up the full stack locally.

# run a local dynamodb
$ docker-compose -f test/docker-compose-dynamodb.yml up -d

# run the backend locally and build frontend
$ make local

# run frontend server
$ http-server frontend/dist

License

MIT

About

An open source clone of Geoguessr that can be hosted serverless for free in your AWS account

Topics

Resources

Stars

Watchers

Forks