DevSocHackathon - Falcon Music

About

Falcon Music is an online music player web app. The app is deployed here : https://falcon-music.herokuapp.com.

Table of Contents

• Quick Start 💥
• Documentation 🧾
• Browser Support 🌐
• Installation 🐣
• Contribution Guidelines ✒
• How to use ? 📖
• Current Implementations 👨‍💻
• Future Implementations 💻
• Individual Contribution ☕

Quick Start

Browser Support

Edge	Firefox	Chrome	Safari	Opera
Edge	last 3 versions	last 3 versions	last 3 versions	last 3 versions

Installationgit

Follow these steps to install this project directory:

# clone the repo
$ git clone https://github.com/ArnavBorkar/Falcon-Music-Frontend.git

Contribution Guidelines

1. Fork the repo on GitHub.
2. Clone the project to your own machine.
3. Commit changes to your own branch.
4. Push your work back up to your fork.
5. Submit a pull request. (Make sure you merge before you make a pull request!)

Pull Request Guidelines

1. The subject should be a short one line summary of the change you've made.
2. The extended description should include a deatiled description of the changes you've made and also a list of all the files you've made changes in.
3. One pull request should cater to only one change. *A change may include multiple file changes that are essential to solving the issue/change.

How to use?

1.Open the website on your mobile or laptop. 2.The all songs tab consists of all the songs in our library that a user can access and play. 3.The search option can be used to search for a particular song and play it. 4.You can even create your own playlists (upto 6) by clicking on the add button besides create new playlist and add songs to the playlist. 5.After creating the playlist, choose the playlist you want to add the current playing song to and press the plus button besides it. 6.Users can also add songs to a special liked songs playlist by clicking on heart button at top right of the song cover. 7.The last song of the playlist can be removed from that playlist by using Trash button at the bottom of that playlist. 8.After the current song is finished, the next song will be automatically played.

Current Implementations

1. Frontend of the whole project is done using HTML and CSS and JS.
2. A server has been created that using Express and NodeJS that hosts the website.
3. Firebase has been used to store song data and the songs have been stored on firebase's storage service.
4. The site is entirely responsive and has a interface on mobiles and tabs as good as on PCs if not better.

Future Implementations

1. User Authentication and creation of accouts for differents users.
2. Use other available APIs like spotify's to access song data and show it the user.
3. A backend that stores the user's data so that the user doesn't lose data when he/she closes it.
4. Create a better interface.
5. Create more routes for increasing efficiency of the website.

Individual Contribution

Arnav Borkar - UI/UX and CSS, all functionalitis/JS of site (including playlist and now playing), hosting backend on NodeJS with ExpressJS
Rishi Roy - Website Styling Implementation (CSS), creation and handling of cloud storage.
Varun Gopal - Implementing search function and its CSS, ReadMe

Social Media

Instagram: https://www.instagram.com/devsocbitsgoa

Devsoc's Website: https://devsoc.club/