Giter VIP home page Giter VIP logo

soul-blind-test's Introduction

The Vintage Blindtest

This is a blind test game that allows you to test your knowledge of vintage soul songs.

UX

This website is obviously for people who like old soul songs, otherwise it may be hard to play. The typical user would be a music lover who wants to try or prove his knowledge, or someone who likes this kind of music and wants to discover some songs.

The mockups can be found here

Features

Existing Features

  • Use the API from spotify to create the songs data (get_songs.py)
  • Record users and their scores
  • The game: show a random song, take guesses, calculate the points, keep track of the result
  • The leaderboard: show the top ten players

Features Left to Implement

  • Accept answers that are 80% correct
  • Contact form: send me an email

Technologies Used

  • Flask
    • I use Flask to handle page routing and other backend functions
  • SQL Alchemy and SQLite
    • I use SQL Alchemy and SQLite for the database and db queries
    • Note: the website is deployed on heroku with a SQLite database. SQLite databases are currently not supported by Heroku meaning that the data is deleted after a few hours.
  • Bootstrap 4
    • I use Bootstrap to give the project a simple, responsive layout
  • Spotipy
    • I use Spotipy to get the data from Spotify.

Testing

  • The functions related to the database are tested in database_test.py
  • The other python functions are tested in tests.py
  • Documentation for the user testing can be found there : User Tests

Deployment

Local

  1. Firstly you will need to clone this repository by running the git clone https://github.com/mathilde206/soul-blind-test command
  2. Then you need to install all the dependencies from the requirements.txt file:
pip install -r requirements.txt

  1. To start the application : python3 run.py

Production

The website is deployed on heroku at vintage-blindtest.herokuapp.com To deploy, I included two environment variables : IP: 0.0.0.0 and PORT: 5000

Credits

Media

  • The music extracts come from Spotify through spotipy.
  • The background image comes from Unsplash from Mr Cup / Fabien Barral on Unsplash (Free of rights)

soul-blind-test's People

Contributors

mathilde206 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.