Develop an elegant React.js Music Application.
When contributing to this repository, please first discuss the change you wish to make via issue. Please note we have a code of conduct, please follow it in all your interactions with the project.
To get started with development, you need to install few tools
-
git
git
version 2.13.1 or higher. Download git if you don't have it already.To check your version of git, run:
git --version
-
node
node
version 16.15.1 or higher. Download node if you don't have it already.To check your version of node, run:
node --version
-
npm
npm
version 5.6.1 or higher. You will have it after you install node.To check your version of npm, run:
npm --version
To set up a development environment, please follow these steps:
-
Clone the repo
git clone https://github.com/JavaScript-Mastery-PRO/project1_team4_repository.git
-
Change directory to the project directory
cd project1_team4_repository
-
Install the dependencies
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.
-
Run the app
npm run dev
Project will be running in the browser.
Open http://localhost:3000 to view it in your browser.
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. 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.
There are 2 main work flows when dealing with pull requests:
- Pull Request from a forked repository
- Pull Request from a branch within a repository
Here we are going to focus on 2. Creating a Topical Branch:
-
First, we will need to create a branch from the latest commit on master. Make sure your repository is up to date first using
git pull origin main
Note:
git pull
does agit fetch
followed by agit merge
to update the local repo with the remote repo. For a more detailed explanation, see this stackoverflow post. -
To create a branch, use
git checkout -b <new-branch-name> [<base-branch-name>]
, wherebase-branch-name
is optional and defaults tomain
.Use a standard convention for branch names. For example,
<your-name>-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 themain
branch and push it to github.git checkout -b jsm-dev main git push origin jsm-dev
-
To create a pull request, you must have changes committed to your new branch.
-
Go to Pull Requests and click on the
New Pull Request
button. -
Select the
main
branch as thebase
branch and thejsm-dev
branch as thecompare
branch. -
Follow the template and fill in the proper information for the pull request.
-
Click on the
Submit
button. -
You have successfully created a pull request. Now wait for mentor approval. Once approved, you can merge the pull request.