Welcome to the Health Care Server project! This repository contains the server-side code for our Health Care application. This README file provides guidelines on how to build and contribute to the project as a team. Please make sure to follow these instructions to maintain a consistent and efficient development process.
-
Clone the Repository:
git clone https://github.com/Programming-Hero-Next-Level-Development/health-care-server.git
-
Navigate to the Project Directory:
cd health-care-server -
Please update the filename from
.env.exampleto.env -
Install Dependencies:
yarn install
-
Start the Server:
yarn dev
The server will be running at
http://localhost:3000.
To contribute to the project, follow these guidelines:
-
Create a Feature Branch: Before starting work on a new feature, create a feature branch:
git checkout -b feature/your-feature-name
-
Write Code: Implement the feature or fix the bug on your feature branch.
-
Commit Changes: Commit your changes with a meaningful commit message:
git commit -m "Add your commit message here" -
Push Changes: Push your changes to your feature branch:
git push origin feature/your-feature-name
-
Create a Pull Request (PR): Create a pull request from your feature branch to the
developmentbranch on GitHub. Ensure the PR title and description are descriptive. -
Code Review: Your code will be reviewed by other team members. Address any feedback and make necessary changes.
- Main Branch:
The
mainbranch is reserved for stable releases. Do not directly push to the main branch. - Issues and Bug Tracking: Use the GitHub Issues tab to report bugs, suggest features, or discuss enhancements.
- Coding Standards: Follow the coding standards and conventions established by the team. Ensure your code is well-documented.