Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 1.83 KB

README.md

File metadata and controls

55 lines (34 loc) · 1.83 KB

Emoji Battle

🤪 ⚔️ 😀

A simple, multiplayer game built with the full-stack Jamstack.

emoji-battle-round-in-progress

Libraries

Prerequisites

  1. PostgreSQL (I recommend Postgres.app on Mac)
  2. A free Ably account.
  3. An Ably API key.
  4. Create a GitHub OAuth app. You'll need the private key and secret to enable GitHub authentication.
  5. You'll also need to install the Emoji Battle timer server locally.

Installation

  1. Clone the repository.
  2. yarn or yarn install.
  3. Copy .env.example to .env and fill in the values.

Running the app

In one terminal window, start the client:

yarn dev

In another, start the timer server:

yarn start:dev

Visit http://localhost:3000 to play on your local machine 🎉. Happy battling!

Contributing

Reach out to me on Twitter: @mcavaliere.


Built by Mike Cavaliere (@mcavaliere)

Supported by Echobind (@echobind).