Git Product home page Git Product logo

coverdle's Introduction

Coverdle

A daily puzzle game challenging players to guess album covers within a limited time frame.

Technologies Used

  • Flask: A lightweight WSGI web application framework used to serve the web interface and handle backend logic.
  • Redis: Employed for caching to improve performance and reduce database load.
  • PostgreSQL: The primary database for storing puzzle data, user responses, and other necessary information.
  • jQuery: Utilized for the frontend to create interactive web pages and simplify DOM manipulation, event handling, and Ajax interactions.

Getting Started

To run Coverdle locally, follow these steps:

  1. Clone the Repository:
git clone https://github.com/kerollosy/coverdle.git
cd daily-music-puzzle
  1. Set Up Environment Variables: Create a .env file in the project root and define the necessary environment variables:
REDIS_URL=redis://localhost:6379

POSTGRES_HOST=localhost
POSTGRES_DATABASE=yourdatabase
POSTGRES_USER=youruser
POSTGRES_PASSWORD=yourpassword 

SECRET_KEY=yoursecretkey
ADMIN_PASSWORD=password
  1. Install Dependencies:
pip install -r requirements.txt
  1. Initialize the Database: Ensure your PostgreSQL database is set up according to the schema expected by the application.

  2. Run the Application:

flask run

The application will start running on http://localhost:5000.

Todo

In Progress

  • Make a confirmation when the user clicks the "I don't know" button
  • Switch from alerts() to popups
  • When an album is added to the control panel, it should be added to the suggestions automatically

Done โœ“

  • Save cookies till the next day to prevent players from replaying the same day
  • Make the contact button send an email to me
  • View the correct answer and a timer after the user finishes
  • View the statistics (finished within x seconds and with y guesses left)
  • Show the recommendations correctly
  • Make it "daily"

Contributing

Contributions to Coverdle are welcome! Whether it's bug fixes, new features, or improvements to the documentation, feel free to fork the repository and submit a pull request.

coverdle's People

Contributors

kerollosy 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.