The Blood Donation Project is an initiative aimed at connecting individuals in need of blood with willing blood donors. The project utilizes npm (Node Package Manager) and version control using Git to manage the codebase and facilitate collaboration.
To contribute to the project, follow the steps below:
-
Fork the Repository
- Go to the GitHub repository at https://github.com/Saurav-Pant/Blood-Donation-Project.
- Click on the "Fork" button in the top-right corner of the page.
- This will create a copy of the repository in your GitHub account.
-
Clone the Repository
- On your local machine, open a terminal or command prompt.
- Use the following command to clone the repository:
git clone https://github.com/your-username/Blood-Donation-Project.git
- This will create a local copy of the repository on your machine.
-
Install Dependencies
- Navigate to the project's root directory:
cd Blood-Donation-Project cd Client
- Run the following command to install the project dependencies using npm:
npm install
- Run the following command to start the client:
npm start
- Navigate to the project's root directory:
-
Start Server
- For starting server you have to follow these steps -
- Start the server by opening a terminal or command prompt.
- Navigate to the server directory using the
cd
command:cd Server
- Run the following command to install dependencies
npm install
- Run the following command to start the server:
nodemon Server.js
-
Maintaining Synchronization
- Always take a pull from the repository to your master branch to keep it updated with the updated repository
git pull
- Always take a pull from the repository to your master branch to keep it updated with the updated repository
-
Creating a New Branch
-
Before starting work on a new feature or bug fix, create a new branch with your GitHub profile name:
git checkout -b your-github-profile-name
-
-
Start Contributing
- Now that you have set up the project on your local machine, you can start contributing to the project by adding the necessary functionality to connect blood donors with individuals in need.
-
Committing Changes
-
After making changes to the code, use the following command to stage the changes:
git add .
-
Commit the changes with a descriptive message:
git commit -m "Add feature XYZ"
-
-
Pushing Changes
- Push your changes to your forked repository:
git push -u origin your-github-profile-name
- Push your changes to your forked repository:
-
To create a pull request, go to your fork of this repository,, you will see
compare and pull requests
. Click on that big green button -
Add an appropriate title and description to your pull request explaining your changes and efforts done.
-
Click on
Create Pull Request
. -
Voila! You have made a PR to the Blood-Donation-Project 💥 Wait for your submission to be accepted and your PR to be merged 🎉
When contributing to the Blood Donation Project, please ensure that you follow these guidelines:
- Before starting work on a new feature or bug fix, create a new branch for your changes.
- Make your changes and test them thoroughly.
- Ensure that your code follows the project's coding style and conventions.
- Write clear commit messages that explain the purpose and details of your changes.
- Push your changes to your forked repository.
- Submit a pull request to the original repository, clearly describing the changes you have made.
The Blood Donation Project aims to make a positive impact by connecting blood donors with individuals in need of blood. By following the steps mentioned above, you can contribute to this project and help save lives. Thank you for your support!