Guess The Song - SERVER

The server behind Guess The Song, it downloads songs, manages lobbys and handles game-flow

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

The server communicates over a simple websocket protocol that I came up with myself, it allows for a variety of clients and platforms!

Some possible clients that could easily be made:

• A phone app that can be used in group settings
• A desktop app for optimal performance and usability
• A terminal client for advanced users 😄

(back to top)

Built With

• ![Rust][rust-lang.org]

(back to top)

Getting Started

To set this up locally, you will need the following:

Prerequisites

• rust installation
• yt-dlp

  pip install yt-dlp
  # ensure the program is in your PATH and can be executed

Installation

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Install cargo packages

   cargo c

(back to top)

Usage

Running the server ⚙️

cargo run

(back to top)

Roadmap

• Lobby system

• Song downloads

• Song guessing flow

• Add more game modes

• Allow changing the max guessing time

See the open issues for a full list of proposed features (and known issues).

(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)

Contact

Valentin - @v_bltz

Project Link: https://github.com/VirusBLITZ/guess_the_song_backend

(back to top)

Acknowledgments

• @FoggySky - ideas and opinions
• Img Shields

(back to top)