Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.96 KB

README.md

File metadata and controls

62 lines (41 loc) · 2.96 KB
Raw

Pictionary image

Pictionary

Pictionary is a free multiplayer drawing and guessing game.

A game consists of a few rounds in which every round someone has to draw their chosen word and others have to guess it to gain points! Players with the highest scores are the winners at the end of the game.

Play now!

A Demo of the app

Pictionary.-.Awesome.Screenshot.00_00_02-00_02_02.mp4

Features

  • Play with your friends in a private room or other users in a public game.
  • Tweak the game according to your likings, and your own custom words.
  • A refreshing new UI and dark mode support
  • If you get disconnected from a game you will not lose your score just rejoin again and continue
  • The best part is it's free and there are NO ADS!

I took inspiration from skribbl.io to make this project, however, I have added a bunch of new stuff in addition to what scribble offers like a new UI, dark mode, ability to preserve scores if disconnected and the best part there are no ads!

Bugs, feature requests, and contributions

Found a bug or want a new feature? Please create an issue.

Want to contribute?

  • Create a PR and I will be happy to review and merge it
  • Start this project
  • Tell your friends about the project.

Like my work? Consider contributing to this project and support me to improve it.

Setup and run locally

If you want to run this project locally continue reading

Few things to know about the technology stack used in the project:

  • The application uses Elixir for the backend server and react js for the frontend application.
  • There is no database, all data is stored in an in-memory database that comes with elixir called ETS and will be lost when the backend server is stopped.

Setup using Docker

Get the app running easily using docker.

  • Install docker and docker compose
  • Clone this project
  • cd into the project directory and run docker-compose up

Thats it! Access the application at http://localhost:3000/

Setup manually

  • Make sure you have elixir and npm installed
  • Clone this project
  • cd into the project directory and install dependencies by running mix deps.get and finally start the backend server by running mix phx.server
  • Next cd into the pictionary-app directory and install dependencies by running npm install and start the front end application by running npm start
  • Enjoy!