Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.44 KB

README.md

File metadata and controls

60 lines (39 loc) · 2.44 KB

SoundGuessy

I notice where is not a way to listen to soundtracks and guessing the Movie, TV-Show, Music, Video Game or Land (Hymne).

📦 Installation

  1. Fork this Repo
  2. Clone it
    git clone https://github.com/${YOUR_USERNAME}/soundGuessy
  3. npm install
  4. After you added your changes, just Create a Pull request with the Change Title and if needed a little description in the body.
  5. I will checkout your code and will add it. Also I really want to say thank you and I will give you credits by adding your Username inside the code as a Comment.

🦄 Demo

Feel free to play the Game

https://tolgakara.github.io/soundGuessy/

🚧 TODO

  • Adding React.js and JEST
  • Using the @apply for Tailwindcss
  • CRUD for the User to create new Decks and adding Cards
  • Further improvement on the Style of the website
  • Adding a Database and store the images and full length of the music in there
  • Playing the game with friends (1vs1)

::hammer_and_wrench: Support

Please open an issue for support.

::memo: Contributing

You can freely contribute to the Project.

For setting up the development environment, please read the Heading 📦 Installation

The issues are listed under this Link or follow the List of 🚧 TODO. Also if it's needed I change the Repo to a Project to create a Kanban view.

Master is the latest version and I will create more branches to divide the complexity.

In the first Iteration I created a simple JavaScript DOM Game. The second iteration is to change the environment to React.js . Also I am using Tailwind CSS and the HTML Files are full of classes so I will minimize it, with @apply on the stylesheets. You can add new modules by changing the Component or adding new Components.

I will add JEST as a Testing Framework. After that feel free to add Tests.

As style guideline I use prettier and I think it's enough. Also I prefer a minimal readable code for this project.

::scroll: Licence

This project is licensed under the MIT License