From d2e8afc1634739bfe95a57a80ea587f2139ec11f Mon Sep 17 00:00:00 2001 From: Kenny Zhang <122967787+kennyzhang0819@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:02:39 -0700 Subject: [PATCH] Update README.md --- README.md | 157 ++++++++++++++---------------------------------------- 1 file changed, 41 insertions(+), 116 deletions(-) diff --git a/README.md b/README.md index 38129ca..db74029 100644 --- a/README.md +++ b/README.md @@ -1,136 +1,61 @@ -# Project Lyrics +# Audiora: Open Source Music Streaming Web App -Develop an elegant React.js Music Application. +![Audiora Thumbnail](thumbnail/app.png) -Check out the complete project requirements [here](https://docs.google.com/document/d/13PeFwRlPEhMw_HPyrIrInvQuKaVWnpNmcv-y3NA208s/edit?usp=sharing) +**Audiora** is a free, open-source music streaming web app inspired by popular platforms like Spotify and Apple Music. Dive into a vast collection of tracks across genres, explore top charts by genre and artist, and sing along with our lyrics display feature. Experience music like never before! -# Contributing +Visit us: [https://audioraweb.com/](https://audioraweb.com/) -When contributing to this repository, please first discuss the change you wish to make via issue. -Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. +## Features +- **Stream by Genre**: Navigate through a diverse range of music genres and find tracks that resonate with your mood. +- **Top Charts**: Discover what's trending! Get the most popular charts curated by genre and artist. +- **Lyrics Display**: Sing along to your favorite tracks with our integrated lyrics viewer. +- **Song Search & Recommendations**: Find that song you've been humming and explore related song recommendations. -## System Requirements +## Tech Stack -To get started with development, you need to install few tools +- **Frontend**: React, Tailwind CSS, Redux +- **Backend**: Node.js +- **APIs**: Rapid API -1. git - - `git` version 2.13.1 or higher. Download [git](https://git-scm.com/downloads) if you don't have it already. +## Getting Started - To check your version of git, run: +### Prerequisites - ```shell - git --version - ``` +- Node.js +- npm or yarn -2. node - - `node` version 16.15.1 or higher. Download [node](https://nodejs.org/en/download/) if you don't have it already. +### Installation - To check your version of node, run: +1. Clone the repository: +``` +git clone https://github.com/kennyzhang0819/Audiora.git +``` - ```shell - node --version - ``` +2. Navigate to the directory: +``` +cd audiora +``` -3. npm - - `npm` version 5.6.1 or higher. You will have it after you install node. +3. Install the dependencies: +``` +npm install +``` - To check your version of npm, run: +4. Start the development server: +``` +npm start +``` - ```shell - npm --version - ``` +Visit `http://localhost:3000` to see the app in action. -## Setup +## Contribution -To set up a development environment, please follow these steps: +Audiora welcomes contributions from the community. Whether it's a bug fix, feature enhancement, or new design! -1. Clone the repo +## Acknowledgements - ```shell - git clone https://github.com/JavaScript-Mastery-PRO/project1_team4_repository.git - ``` - -2. Change directory to the project directory - - ```shell - cd project1_team4_repository - ``` - -3. Install the dependencies - - ```shell - npm install - ``` - - If you get an error, please check the console for more information. - - If you don't get an error, you are ready to start development. - -4. Run the app - - ```shell - npm run dev - ``` - - Project will be running in the browser. - - Open [http://localhost:3000](http://localhost:3000) to view it in your browser. - -## Issues - -You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/orgs/JavaScript-Mastery-PRO/projects/8). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed! - -Please try to create bug reports that are: - -- _Reproducible._ Include steps to reproduce the problem. -- _Specific._ Include as much detail as possible: which version, what environment, etc. -- _Unique._ Do not duplicate existing opened issues. -- _Scoped to a Single Bug._ One bug per report. - - -## Pull Request - -There are 2 main work flows when dealing with pull requests: - -* Pull Request from a [forked repository](https://help.github.com/articles/fork-a-repo) -* Pull Request from a branch within a repository - -Here we are going to focus on 2. Creating a Topical Branch: - - -1. First, we will need to create a branch from the latest commit on master. Make sure your repository is up to date first using - - ```bash - git pull origin main - ``` - - *Note:* `git pull` does a `git fetch` followed by a `git merge` to update the local repo with the remote repo. For a more detailed explanation, see [this stackoverflow post](http://stackoverflow.com/questions/292357/whats-the-difference-between-git-pull-and-git-fetch). - -2. To create a branch, use `git checkout -b []`, where `base-branch-name` is optional and defaults to `main`. - - Use a standard convention for branch names. For example, `-dev`. It will be easier to track your pull requests if you use this convention. - - I'm going to create a new branch called `jsm-dev` from the `main` branch and push it to github. - - ```bash - git checkout -b jsm-dev main - git push origin jsm-dev - ``` - -3. To create a pull request, you must have changes committed to your new branch. - -4. Go to [Pull Requests](https://github.com/JavaScript-Mastery-PRO/project1_team4_repository/pulls) and click on the `New Pull Request` button. - -5. Select the `main` branch as the `base` branch and the `jsm-dev` branch as the `compare` branch. - -6. Follow the template and fill in the proper information for the pull request. - -7. Click on the `Submit` button. - -8. You have successfully created a pull request. Now wait for mentor approval. Once approved, you can merge the pull request. - -# +- The entire **Audiora** team and contributors for making this project possible. +- Platforms like Spotify and Apple Music for the inspiration. +- Rapid API for providing necessary endpoints.