Skip to content

OptimaLPro/IceBreak-Backend

Repository files navigation

IceBreak Backend

IceBreak revolutionizes social interactions with its innovative web application designed to effortlessly break the ice. Select from a diverse array of engaging games, create a room, and invite others to join the fun. Experience an exciting variety of games, from hilarious and embarrassing challenges to knowledge-based quizzes and beyond.

LogoResize

Tech Stack

  • Node.js
  • Express
  • Socket.IO
  • MongoDB
  • Axios
  • Cors
  • And more...

Screenshots

Screenshot 2024-05-18 224008 Screenshot 2024-05-18 224017 Screenshot 2024-05-18 224031 Screenshot 2024-05-18 224057 Screenshot 2024-05-18 224117 Screenshot 2024-05-18 224202 Screenshot 2024-05-18 224147 Screenshot 2024-05-18 224152

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have npm installed. If not, you can install it here.

Installation

  1. Clone the repo

    git clone [https://github.com/OptimaLPro/IceBreak.git](https://github.com/OptimaLPro/IceBreak-Backend.git)
  2. Install NPM packages

    npm install
  3. Create a .env file and add the following

    MONGO_USER_NAME=your_mongodb_username
    MONGO_PASSWORD=your_mongodb_password
    MONGO_CONNECT_URL=your_mongodb_url
  4. Start the development server

    npm start

Available Scripts

  • npm run dev - Runs the app in the development mode.

Usage

  1. Create a game room using the API.
  2. Share the room code with others to join.
  3. Handle real-time communication using Socket.IO.

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.

  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

License

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

About

Want to break the ice? let's go.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published