radioactive11 / vinyl-server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Vinyl

Skribble for Music.

Frontend · User Backend · View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Features
  4. Contributing
  5. License
  6. Contact

About The Project

Vinyl is a multiplayer song guessing game in which the first one (three people actually) to guess the name of the song from its 30 second preview wins.

(back to top)

Built With

FastAPI FastAPI FastAPI Flask Next NodeJS NodeJS

(back to top)

Getting Started

This is an example of how you can setup your own game environment.

Prerequisites

  • Python>=3.7
  • Redis
  • NodeJS
  • Next.js
  • SQLAlchemy

Installation

  1. Clone the repo
    git clone https://github.com/radioactive11/vinyl-server.git
  2. Create and activate virtual environment
    python3 -m venv venv
    source venv/bin/activate
  3. Install the requirements
    python3 -m pip install -r requirements.txt
  4. Set PYTHONPATH environment variable
    export PYTHONPATH=app
  5. Start the server
uvicorn main:app

(back to top)

How to play

Playing vinyl is easy and simple. All you need to do is:

  1. Create a room 🏠
  2. Invite some friends (using the invite link) 💌
  3. Choose your Spotify playlist (or from our Handpicked ones )🤌🏽
  4. Choose the number of rounds 🔢
  5. Guess the song before everyone else 🏆

(back to top)

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

Project Link: https://vinyl-server.radioactive11.com

(back to top)

(back to top)

About

License:MIT License


Languages

Language:Python 100.0%