Skip to content

dorley174/whoami

Repository files navigation

Who Am I?

Game description

Who Am I? is a web representation of the same board game. Its essence is to make some creature to everyone, and then guess it with the help of Yes/No questions.

How to install

1. Clone this repository to any folder in your PC

git clone https://github.com/dorley174/whoami
cd whoami

2. Place Environment Variables

For this project, I use Redis Database to store rooms and enable users from other devices connect to the same room. The database is necessarily needed for the code performance!

So, you need to create your own database. My recomendation is to use Redis When you create a database, you will get an environment variables:

  • UPSTASH_REDIS_REST_URL - URL address for all future requests
  • UPSTASH_REDIS_REST_TOKEN - an unique token to connect with db

Make new file called .env.local and place this variables:

UPSTASH_REDIS_REST_URL=https://some/redis/rest/url
UPSTASH_REDIS_REST_TOKEN=someRedisRestToken

Note: if you will deploy this website to Vercel or other hosting platform, you also will need to add this Environment Variables to this platform

3. Install dependencies described in package.json

npm install

4. Run website locally

npm run dev

Useful commands

  • To format all code
npm run format
  • To build and run project for production
npm run build
npm run start

About

Web version of popular tabletop game "Who am I?"

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published