MusicApp

Table of Contents

• Team
• About the Project
• Features
• Getting Started
• Branch Naming Convention

Team

Meet the talented individuals behind this project:

• Akash Vasava

  • GitHub: Akash9119

• Mohiyaddeen Raza (Project Lead)

  • GitHub: mohiyaddeen7

• Ravi Maurya

  • GitHub: ravi2977

• Lipi Dey

  • GitHub: LipiDey

• Binod Rai

  • GitHub: binodrai9

About the Project

The MusicApp project is a learning endeavor by our team, consisting of Akash Vasava, Mohiyaddeen Raza, Lipi Dey, and Binod Rai. The primary purpose of this project is to gain practical experience in web development and application design.

Key Highlights:

• Project Purpose: This MusicApp is not intended for production use but rather serves as a practical playground for honing our web development skills.

• Technology Stack: The project is built using React.js, Tailwind CSS, SpringBoot, and MySql + firebase. These technologies are widely used in web development and offer a great opportunity for hands-on learning.

• Closed Project: Please note that this project is not open source, and its primary focus is on internal learning and skill development within our team. It is not meant for public contributions but rather a platform for our personal growth in web development.

Features

List the key features of your MusicApp . You can use bullet points for this section, like:

• Music streaming and playlist management
• Search and discover new music
• More features will be added'

Snapshots

1. Home Page

2. Playlist and songs page

3. Music Player Page

4. Karaoke Mode - Normal

5. Karaoke Mode - Instrumental

6. Media Dashboard Page

7. Add song Page

Getting Started

To set up and run this MusicApp project locally, follow these steps:

Prerequisites

Make sure you have the following software and tools installed on your system:

• Web browser
• Code editor (e.g., Visual Studio Code)
• Git (optional, for cloning the project repository)

Installation

1. the project repository to your local machine (if you have Git installed):

git clone https://github.com/tataNeonKnights/MusicApp_.git

Branch Naming Convention

Introduction This document outlines the branch naming convention for our project. Following a consistent branch naming convention helps us better organize and manage our codebase. Please adhere to the rules and guidelines specified below when creating and naming branches.

Branch Types Feature Branches (feature): Used to work on a specific feature or issue. The branch name should follow the format: feature-<issue_number>-<author_name>-<short_description>. Example: feature-3-Alice-Add-User-Auth

Bug Fix Branches (bug): Used to address and fix bugs or issues. The branch name should follow the format: bug-<issue_number>-<author_name>-<short_description>. Example: bug-15-Bob-Fix-Navigation-Bug

Update Branches (update): Used to address updates in the production environment. The branch name should follow the format: update-<issue_number>-<author_name>-<short_description>. Example: update-101-David-Updated-Navbar

Guidelines

1. Keep branch names concise and descriptive. Avoid long branch names.
2. Use lowercase letters for branch names.
3. Separate words in the branch name with hyphens (-) for readability.
4. Always include the issue number, author's name, and a short, meaningful description.
5. Use the appropriate branch type prefix (e.g., feature, bug, fix) to indicate the purpose of the branch.
6. Collaborate and communicate with your team to ensure everyone understands and follows the naming convention.

Example Branch Names Feature Branch: feature-3-Alice-Add-User-Auth Bug Fix Branch: bug-15-Bob-Fix-Navigation-Bug Update Branch: update-101-David-Updated-Navbar

Conclusion Consistently following this branch naming convention will improve codebase organization, enhance collaboration, and simplify branch tracking. By adhering to these guidelines, we ensure that our project remains well-maintained and organized.