Skip to content

Instantly share code, notes, and snippets.

@MartaJank
Last active October 30, 2020 12:24
Show Gist options
  • Save MartaJank/b8a5cf626a78a11fa8f58c59b749dccc to your computer and use it in GitHub Desktop.
Save MartaJank/b8a5cf626a78a11fa8f58c59b749dccc to your computer and use it in GitHub Desktop.
Example of Readme

Track Tracker - M1 Project

​ ​

Description

​ Tired of listening the same songs over and over again and want to find some new music but don't know how to search for it? With Track Tracker it's easier than you think! Now you can choose the music genre you want and get four random songs recommended to you. Not satisfied with the result? Don't worry, you can push the shuffle button as many times as you like and get four different songs every time. Or you can try with a different genre. Easy, isn't it? 😄 ​ ​ Track Tracker has been developed as a part of the Ironhack Web Developement bootcamp with the Deezer API and using JavaScript. ​

MVP (Minimum Viable Product)

​ The MVP will include: ​

  • Homepage: it will include all the links to navigate around the app and the music genre buttons which will lead the user to the random songs. 🏠
  • Random songs selection page: which will include the random selection of four songs (filtered by the genre the user has previously selected) and a shuffle button (to get a new selection of four songs). It will also give a link to get to the home page and change the genre. 🔀
  • Sign Up: A registration form for new users with email and password validation. 👋
  • Log In: A form for signed up users with email and password validation. 🔑
  • FAQ: Everything you would want to know about Track Tracker, just press play. ⏯️ ​

Backlog

  • Search bar for easy desired genre search with more specific genres than the ones displayed on the main page. ​
  • More strict password validation. ​
  • Add a Log Out option once the user is logged and say "Hi, ${name}" on the navbar instead of having still the Log In and Sign Up options displayed. ​

Wireframes

Data structure

  • root/
    • index.html
    • randomsongs.html
    • faq.html
    • login.html
    • signup.html
    • css/
      • style.css
      • burger.css
    • src/
      • Main.js
      • Login.js
      • Database.js
      • Signup.js
      • User.js
      • Validator.js
  • img/

API

  • Check out the amazing Deezer API I used. 🎶 ​

Links

Trello

My 'Trello' board

GitHub

Project GitHub

Slides

My Presentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment