Merge pull request #7 from Satyam1923/fix-issue-1

Add LEARN.md

LEARN.md

@@ -0,0 +1,70 @@
+Project Overview:
+
+    Spring Music Player is a web application designed to offer users a seamless music streaming experience by integrating with the JioSaavn API. Users can search for music, albums, playlists, and singers, control playback, view top searches, and loop playback. The application is built using a client-server architecture with React on the client-side and Node.js, Express, and Firebase on the server-side.
+
+Features:
+
+    Music/Album/Playlists/Singer Search: Users can search for music, albums, playlists, and singers.
+    Playback Controls: Users can control playback, including play, pause, skip, and loop options.
+    Top 10 Search List: Displays a list of the top 10 searched items for easy discovery.
+    Loop Playback: Allows users to loop playback for continuous listening.
+
+Tech Stack:
+
+    Client: EJS, CSS , JS
+    Server: Node.js, Express,  Axios
+    API: JioSaavn API (unofficial)
+
+
+Getting Started:
+
+    Clone the repo:
+
+    git clone https://github.com/Satyam1923/Spring.git
+
+Install npm packages:
+
+    npm install .
+
+Start it on local host:
+
+    node index.js
+
+    Visit local host:
+    http://localhost:3030/
+
+Contributing:
+
+     Contributions to the project are welcomed and appreciated. If you have any suggestions, bug reports, UI improvements, or enhancements, feel free to open an issue to discuss or directly create a pull request with the necessary changes. Please ensure to check spelling, grammar, and create individual pull requests for each suggestion.
+
+Creating Pull Request:
+
+    Fork the Project
+    Clone your forked repositor
+
+     git clone https://github.com/Satyam1923/Spring.git
+
+Create a new branch and switch to it:
+     git checkout -b fix-issue-<ISSUE-NUMBER>
+
+Add your changes:
+
+    git add .
+
+Commit your changes:
+
+    git commit -m "<EXPLAIN-YOUR_CHANGES>"
+
+Push your changes:
+    git push origin fix-issue-<ISSUE-NUMBER>
+
+    Open a Pull Request
+
+Learnings:
+
+    Client-Side Development: Understanding how to build a user-friendly interface using React and TailwindCSS.
+    Server-Side Development: Utilizing Node.js and Express for server-side logic and API integrations.
+    Firebase Integration: Learning to integrate Firebase for user authentication and data storage.
+    Git Workflow: Understanding the Git workflow for contributing to open-source projects, including forking, branching, committing, and creating pull requests.
+
+    Feel free to explore and contribute to the Spring Music Player project to make it even better!