Skip to content

Yagnik-Gohil/skribbl-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧠 Skribbl Back-End (Express & Socket.io)

This is the backend server for the Skribbl clone game, handling real-time communication, game state management, and player interactions using Express and Socket.io.

🔗 Front-End Repository: Yagnik-Gohil/skribbl


🎯 Why I Built This

The goal was to create a robust backend that supports real-time multiplayer gameplay, ensuring seamless synchronization between players. Implementing this with Express and Socket.io provided an opportunity to delve deep into WebSocket communications and server-side game logic.


🚀 Quick Start

Prerequisites

  • Node.js
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/Yagnik-Gohil/skribbl-server.git
    cd skribbl-server
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Start the server:

    npm run dev
    # or
    yarn dev

    The server will start on http://localhost:3001 by default.


📖 Usage

  • Real-Time Communication: Utilizes Socket.io for bi-directional communication between clients and the server.
  • Game Management: Handles game rooms, player sessions, drawing events, and chat messages.
  • API Endpoints: Provides RESTful endpoints for room creation, player management, and game state queries.

🤝 Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b feature/YourFeatureName
  3. Make your changes and commit them:

    git commit -m 'Add your feature'
  4. Push to the branch:

    git push origin feature/YourFeatureName
  5. Open a pull request.


🛠️ Built With


📄 License

This project is licensed under the MIT License.

About

Skribbl Back-End (Express & Socket.io) - ⚠️ Server is Down ⚠️

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published