diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dcc9c8a..229a22a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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! diff --git a/README.md b/README.md index 5cd07d8..c33ceb2 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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