UltimateHealth is an innovative open-source project that aims to provide a comprehensive online library and article management application focused on health. The project is designed to cater to users who are looking for reliable and trustworthy information on various health-related topics.
From the beginner perspective, the project consists of three main modules: Article Section, Chat Section, and Podcasts. The Article Section includes:
- Diseases-related information
- General health-related guidance
- Survival experiences from critical diseases
- Backend Development
Users can also listen to articles(audio features) if they prefer. The Chat Section features a guider bot that helps users solve their health-related problems.
Hello! Congratulations to all the GSSOC'24 contributors and mentors!🎉 I'm thrilled to be a part of this amazing team and I'm excited to work together to make the Ultimate Health project a huge success. Let's collaborate, learn, and grow together!
Follow these steps to get started with UltimateHealth:
Clone the repository:
https://github.com/SB2318/UltimateHealth.git
cd UltimateHealth
Checkout develop branch and select your preferences (backend or frontend).
git checkout develop
Install dependencies:
npm install --legacy-peer-deps
Configure the application: (For IOS and Backend)
Update configuration files if necessary. Ensure the Ethereum wallet connection details are set.
Run the applications.
To run the frontend server use:
For android :
npm run android
For ios:
npm run ios
For backend:
node server.js
Access the application: Open your web browser and navigate to (LOCAL_HOST_URL). If you would like to contribute to the project, please follow the contribution guidelines.
-
Checkout and make your changes for the develop branch only: When working on your contributions, switch to the develop branch in your local repository. This ensures that you are working on the latest version of the codebase.
-
Create pull requests only for the develop branch: When you are ready to submit your changes, create a pull request (PR) targeting the develop branch. This allows the maintainers to review and merge your code into the main development branch.
-
Maintain contribution guidelines: Each project may have its own specific contribution guidelines. It's important to familiarize yourself with these guidelines before submitting your contributions. Adhering to these guidelines ensures consistency and helps maintain the quality of the codebase.
-
Format your commit message with the issue number: When making commits related to an issue, follow the format Fixes: #32 in your commit message. Replace 32 with the issue number you are addressing. This helps track and manage issues more efficiently.
-
Attach a Postman response screenshot for backend tasks: For tasks related to the backend, it is recommended to include a screenshot of the Postman response along with your pull request. This provides additional context and helps reviewers understand the changes made and their impact on the backend functionality.
-
Make your pull request descriptive and include examples: When creating a pull request, provide a clear and descriptive explanation of the changes you made. This helps reviewers understand the purpose and significance of your contribution. Additionally, including at least one example that demonstrates the intended usage or effect of your changes can be beneficial.
-
Rebase your commits and optimize file changes: When submitting your pull request, consider rebasing your commits into one commit and optimizing your file changes. This helps keep the commit history clean and makes it easier for reviewers to understand your changes.
Remember, following these guidelines will help ensure a smooth and efficient contribution process. Happy coding!
Discord Server (Susmita Bhattacharya, user_name: susmita_)