search

ViciousFish / buzzwords

A browser based word strategy game featuring frictionless link-based multiplayer. Try it today!
https://buzzwords.gg
Apache License 2.0
48 stars 9 forks source link
game hacktoberfest react react-three-fiber three-js

readme

Buzzwords.gg

"Scrabble meets Go" - a hexagonal word game about strategically taking territory

gameplay demo

Follow our twitter for updates

https://twitter.com/BuzzwordsGG

Running the code for development

  1. drop a .env file in ./server with API_PREFIX=/api
  2. run yarn in this folder
  3. run yarn dev in this folder
  4. go to http://localhost:5173/ in your browser

By default, the server stores all its data in memory only. To use mongo, drop a .env file in ./server with 

DB_TYPE=mongo
MONGO_URL=<your connection string>

Because we're using transactions, your mongo must be a replica set. We're using Atlas for this reason.

Running the code in production

For now, production is dockerized with docker compose. docker-compose build or docker-compose pull, then docker-compose up. You'll need a .env file in the root folder with 

MONGO_URL=<your connection string>
COOKIE_DOMAIN=<the domain you're hosting the API on>
MONGO_DB_NAME=<the name of your db, should match what's after the slash in your connection string>

TODO document FCM stuff. for now see https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments