Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the Contributing.md file #89

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Contribution Guidelines

Thank you for contributing to our project! Please follow these guidelines before submitting a pull request (PR).
- If you have any suggestions for the projects, like reporting a bug, improving UI, or improving the README.md file, feel free to **open an issue** to discuss it, or directly create a pull request with the necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.

## Setup Instructions
1. Clone the repository to your local machine.
Expand Down Expand Up @@ -30,6 +33,6 @@ Thank you for contributing to our project! Please follow these guidelines before
4. Verify that your PR meets the project's acceptance criteria.

## Contact Information
If you have any questions or need assistance, you contace me on https://discord.gg/UAC2Ys2m or open an issue for discussion.
If you have any questions or need assistance, you contact me on https://discord.gg/UAC2Ys2m or open an issue for discussion.

We appreciate your contributions to the project!
62 changes: 61 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Go to this url : http://localhost:3030/
### For frontend
1. Change to frontend folder
```sh
cd backend
cd frontend
```
2. Install npm packages
```sh
Expand All @@ -68,6 +68,66 @@ Contributions are what makes the open source community such an amazing place to
- If you have any suggestions for the projects, like reporting a bug, improving UI, or improving the README.md file, feel free to **open an issue** to discuss it, or directly create a pull request with the necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.

## Contributing Readme.

### For someone working on backend
1. Change directory
```sh
cd backend
```
2. Install npm packages
```sh
npm install .
```
3. Go to localhost
```sh
https://localhost:3030/
```
### For someone working on frontend
1. Change directory
```sh
cd frontend
```
2. Install npm packages
```sh
npm install .
```
3. Run server
```sh
npm run dev
```

## For someone working on backend+frontend
1. Change directory
```sh
cd backend
```
2. Install npm packages
```sh
npm install .
```
3. Go to localhost
```sh
https://localhost:3030/
```
4. Change directory
```sh
cd frontend
```
5. Install npm packages
```sh
npm install .
```
6. Change directory
```sh
cd src
```
7. change in app.jsx under app component fetchSongData function
change this url https://spring-music-player-3hyj.vercel.app/search with https://localhost:3030/search



## Creating Pull Request
1. Fork the Project
2. Clone your forked repository
Expand Down