Drawilio

A Multiplayer Draw and guess game !
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About The Project

Drawilio is a drawing multiplayer game that you can play with your friends 😄.

(back to top)

Tech Stack used

• React.js
• socket.io
• Node
• Express
• Redis

(back to top)

Getting Started

To get a local copy up you have to first create a cluster in redis cloud .

Prerequisites

npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Hamziss/Drawilio.git

2. Install NPM packages inside Drawilio-Api and Drawilio-Front

   npm install

3. Enter this env variables in .env

   REACT_APP_API_URL=http://localhost:5000/
   PORT=5000
   REDIS_ENDPOINT_URI= your redis endpoint uri
   REDIS_PASSWORD= your redis cluster password
   

4. start the server and the front with two terminal by running :

   npm start
   

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)