-
Notifications
You must be signed in to change notification settings - Fork 55
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
Add learn.md #106
base: main
Are you sure you want to change the base?
Add learn.md #106
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
- Contributing to Nacto-care 🎓 | ||
Welcome to the EduWeb project! We're excited to have you contribute. Before you get started, please take a moment to review the guidelines for contributing. | ||
|
||
- Table of Contents 📑 | ||
Getting Started | ||
Code of Conduct | ||
How to Contribute | ||
Reporting Bugs | ||
Suggesting Enhancements | ||
Pull Requests | ||
Coding Guidelines | ||
- License | ||
|
||
- Getting Started 🚀 | ||
- Code of Conduct 🤝 | ||
Please review and adhere to the Code of Conduct while participating in this project. Let's work together to create a positive and welcoming community. | ||
|
||
- How to Contribute | ||
- Reporting Bugs | ||
If you encounter a bug or unexpected behavior, please open an issue and provide detailed information about the problem. Include steps to reproduce the issue, expected and actual results, and any relevant logs or screenshots. | ||
|
||
- Suggesting Enhancements | ||
Have an idea for a new feature or improvement? Open an issue to suggest your enhancement. Describe the feature, its use cases, and how it could benefit the project. | ||
|
||
- Pull Requests 🔄 | ||
We welcome pull requests from contributors. To submit a pull request: | ||
|
||
1). Fork the repository and create a new branch. | ||
2).Make your changes and commit them with descriptive messages. | ||
3).Push your branch to your forked repository. | ||
4).Run npm run eslint in the root of the project to make sure your contributions are in line with our coding guidelines. | ||
5).Run npm run eslint-fix in the root of the project for ESLint to fix the issues it can. | ||
6).Open a pull request from your branch to the main repository. | ||
7).Provide a clear description of your changes and why they're valuable. | ||
Please ensure your code adheres to the Coding Guidelines. Make sure to read PR Guidelines and Issue Guidelines first. | ||
|
||
- Coding Guidelines 📝 | ||
-Follow the established coding style and conventions. | ||
-Write clear and concise code with meaningful comments when necessary. | ||
-Test your changes thoroughly before submitting a pull request. | ||
-Document new features, changes, or important concepts as needed. | ||
|
||
- Contact Information | ||
For more ways to get in touch, refer to Harsil Jani[https://linkedin.com/in/harshil1] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please remove personal contact since moving forward, I will not be the only stakeholder on the project. Instead give a reference to [email protected] |
||
|
||
- License | ||
By contributing to this project, you agree that your contributions will be licensed under the MIT License. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We are not using MIT License. We use GNU GPL 3.0 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
- Contributing to Nacto-care 🎓 | ||
Welcome to the EduWeb project! We're excited to have you contribute. Before you get started, please take a moment to review the guidelines for contributing. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's not EduWeb. Please be mindful while pasting the content @aasthakourav20 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's not EduWeb. Please be mindful while pasting the content @aasthakourav20 |
||
|
||
- Table of Contents 📑 | ||
Getting Started | ||
Code of Conduct | ||
How to Contribute | ||
Reporting Bugs | ||
Suggesting Enhancements | ||
Pull Requests | ||
Coding Guidelines | ||
- License | ||
|
||
- Getting Started 🚀 | ||
- Code of Conduct 🤝 | ||
Please review and adhere to the Code of Conduct while participating in this project. Let's work together to create a positive and welcoming community. | ||
|
||
- How to Contribute | ||
- Reporting Bugs | ||
If you encounter a bug or unexpected behavior, please open an issue and provide detailed information about the problem. Include steps to reproduce the issue, expected and actual results, and any relevant logs or screenshots. | ||
|
||
- Suggesting Enhancements | ||
Have an idea for a new feature or improvement? Open an issue to suggest your enhancement. Describe the feature, its use cases, and how it could benefit the project. | ||
|
||
- Pull Requests 🔄 | ||
We welcome pull requests from contributors. To submit a pull request: | ||
|
||
1). Fork the repository and create a new branch. | ||
2).Make your changes and commit them with descriptive messages. | ||
3).Push your branch to your forked repository. | ||
4).Run npm run eslint in the root of the project to make sure your contributions are in line with our coding guidelines. | ||
5).Run npm run eslint-fix in the root of the project for ESLint to fix the issues it can. | ||
6).Open a pull request from your branch to the main repository. | ||
7).Provide a clear description of your changes and why they're valuable. | ||
Please ensure your code adheres to the Coding Guidelines. Make sure to read PR Guidelines and Issue Guidelines first. | ||
|
||
- Coding Guidelines 📝 | ||
-Follow the established coding style and conventions. | ||
-Write clear and concise code with meaningful comments when necessary. | ||
-Test your changes thoroughly before submitting a pull request. | ||
-Document new features, changes, or important concepts as needed. | ||
|
||
- Contact Information | ||
For more ways to get in touch, refer to RISHI MONDAL[https://www.linkedin.com/in/rishi-mondal-5238b2282/] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Who is RISHI MONDAL ? I guess someone from EduWeb. Please be mindful while pasting the content @aasthakourav20 |
||
|
||
- License | ||
By contributing to this project, you agree that your contributions will be licensed under the MIT License. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Nacto-Care | ||
Visit our website [Nacto-Care]https://nacto-care.vercel.app/ | ||
|
||
## Table of Contents | ||
- Introduction | ||
- Social | ||
- Contributing Guidelines | ||
- Code of Conduct | ||
|
||
|
||
## Introduction | ||
Welcome to Nacto Care! We are on a mission to address the critical shortage of nurses in India while simultaneously revolutionizing the way healthcare services are delivered. With a focus on empowering nurses and enhancing healthcare accessibility, Nacto Care strives to make a meaningful impact in the world's largest democracy. | ||
|
||
## Features | ||
1). Empowering Nurses | ||
- Work Opportunities: Offering a variety of nursing positions with competitive benefits. | ||
- Training Programs: Providing continuous education and skill development. | ||
- Career Advancement: Creating clear pathways for professional growth. | ||
2). Home Nursing Services | ||
- We facilitate immediate access to home nursing services for individuals in need, particularly the elderly. By leveraging technology, we connect patients with qualified nurses, ensuring timely and personalized care in the comfort of their homes. | ||
3). Technology Integration | ||
Similar to how platforms like Zomato and Swiggy have transformed the gig economy, Nacto Care uses innovative technology to: | ||
- Raise Awareness: Promote nursing as a rewarding career choice through outreach programs and educational initiatives. | ||
- Streamline Services: Ensure efficient matching of nurses with patients. | ||
4). Patient-Centric Approach | ||
We prioritize the well-being and satisfaction of our patients by offering additional benefits such as: | ||
- Life Insurance Scheme: Incentivizing patients to choose Nacto Care for their healthcare needs, fostering trust and loyalty. | ||
|
||
|
||
## Contributing Guidelines | ||
For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contributing Guidelines]https://github.com/Nactore-Org/Nacto-Care/blob/main/CONTRIBUTING.md | ||
|
||
## Code of Conduct | ||
For all the enthusiastic contributers, please refer to the [Code of Conduct]https://github.com/Nactore-Org/Nacto-Care/blob/main/CODE_OF_CONDUCT.md | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,106 @@ | ||
Welcome to Nacto Care! We are on a mission to address the critical shortage of nurses in India while simultaneously revolutionizing the way healthcare services are delivered. With a focus on empowering nurses and enhancing healthcare accessibility, Nacto Care strives to make a meaningful impact in the world's largest democracy. | ||
|
||
# Problem Statement | ||
|
||
India currently faces a significant shortage of nurses, with only 2.06 nurses per 1000 people, as reported by the World Health Organization (WHO) in 2023 due to migration because of lack of opportunities. This shortage not only puts strain on the healthcare system but also limits access to essential medical services, especially for vulnerable populations such as the elderly. | ||
# 🌟 Welcome to Nacto Care! 🌟 | ||
Nacto Care is on a mission to address the critical shortage of nurses in India while revolutionizing the delivery of healthcare services. Our focus is on empowering nurses and enhancing healthcare accessibility to make a meaningful impact in the world's largest democracy. | ||
|
||
# Solution | ||
## 🚨 Problem Statement | ||
India faces a significant shortage of nurses, with only 2.06 nurses per 1,000 people, as reported by the World Health Organization (WHO) in 2023. This shortage, largely due to migration stemming from lack of opportunities, puts a strain on the healthcare system and limits access to essential medical services, especially for vulnerable populations such as the elderly. | ||
|
||
- We believe in providing better opportunities and support for Indian nurses, enabling them to thrive in their profession. By offering work opportunity, competitive benefits, training programs, and career advancement opportunities, we aim to attract and retain talented nursing professionals. | ||
- Nacto Care facilitates immediate access to home nursing services for individuals in need, particularly the elderly. By leveraging technology, we connect patients with qualified nurses, ensuring timely and personalized care in the comfort of their homes. | ||
- Similar to how platforms like Zomato and Swiggy have transformed the gig economy, Nacto Care seeks to raise awareness about nursing as a rewarding career choice. Through outreach programs and educational initiatives, we aim to inspire more individuals to pursue nursing as a profession. | ||
- We prioritize the well-being and satisfaction of our patients by offering additional benefits such as a life insurance scheme. This incentivizes patients to choose Nacto Care for their healthcare needs, fostering trust and loyalty in our services. | ||
## 💡 Our Solution | ||
Nacto Care aims to provide better opportunities and support for Indian nurses, enabling them to thrive in their profession. Our approach includes: | ||
|
||
### 🩺 Empowering Nurses | ||
Work Opportunities: Offering a variety of nursing positions with competitive benefits. | ||
Training Programs: Providing continuous education and skill development. | ||
Career Advancement: Creating clear pathways for professional growth. | ||
### 🏡 Home Nursing Services | ||
We facilitate immediate access to home nursing services for individuals in need, particularly the elderly. By leveraging technology, we connect patients with qualified nurses, ensuring timely and personalized care in the comfort of their homes. | ||
|
||
### 📲 Technology Integration | ||
Similar to how platforms like Zomato and Swiggy have transformed the gig economy, Nacto Care uses innovative technology to: | ||
|
||
- Raise Awareness: Promote nursing as a rewarding career choice through outreach programs and educational initiatives. | ||
- Streamline Services: Ensure efficient matching of nurses with patients. | ||
### ❤️ Patient-Centric Approach | ||
We prioritize the well-being and satisfaction of our patients by offering additional benefits such as: | ||
|
||
Life Insurance Scheme: Incentivizing patients to choose Nacto Care for their healthcare needs, fostering trust and loyalty. | ||
## 🚀 Getting Started | ||
To join our mission, you can: | ||
|
||
1). For Nurses: | ||
|
||
- Sign Up: Visit our website to create your profile and explore job opportunities. | ||
- Training Programs: Enroll in our training modules to enhance your skills. | ||
2). For Patients: | ||
|
||
- Request Services: Use our app or website to request home nursing services. | ||
- Benefits Enrollment: Take advantage of our life insurance scheme for added security. | ||
|
||
### 🌍 Impact | ||
By addressing the nursing shortage and improving healthcare accessibility, Nacto Care aims to: | ||
|
||
- Support Nurses: Provide a sustainable and rewarding career path for Indian nurses. | ||
- Enhance Healthcare: Deliver quality care to those who need it most, particularly the elderly and vulnerable populations. | ||
- Strengthen the System: Reduce the strain on India's healthcare system through innovative solutions and dedicated services. | ||
|
||
### 🛠️ Running the Project Locally | ||
To run the Nacto Care project on your local machine, follow these steps: | ||
|
||
#### Prerequisites | ||
Ensure you have the following installed: | ||
|
||
- Git | ||
- Node.js and npm | ||
- MongoDB | ||
|
||
##### Clone the Repository | ||
1) .Open your terminal. | ||
2). Clone the repository using the following command: | ||
``` | ||
git clone https://github.com/your-username/nacto-care.git | ||
``` | ||
3). Navigate to the project directory: | ||
``` | ||
cd nacto-care | ||
``` | ||
##### Install Dependencies | ||
4). Install the server-side dependencies: | ||
``` | ||
cd server | ||
npm install | ||
``` | ||
5). | ||
Install the client-side dependencies: | ||
``` | ||
cd ../client | ||
npm install | ||
``` | ||
##### Configure Environment Variables | ||
6). Create a .env file in the server directory and add the necessary environment variables: | ||
``` | ||
PORT=5000 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Neither we have any service at 5000 |
||
MONGODB_URI=your_mongodb_connection_string | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We don't use MONGODB. |
||
JWT_SECRET=your_secret_key | ||
|
||
##### start the Application | ||
7). Start the server: | ||
``` | ||
cd server | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no server directory. |
||
npm start | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Our backend is in python and not in javascript. npm won't work. |
||
``` | ||
8). Start the client: | ||
``` | ||
cd ../client | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no client folder |
||
npm start | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. npm i there is no npm start script. |
||
``` | ||
The application should now be running on your local machine. Open your browser and navigate to http://localhost:3000 to view the client side, and the server will be running on http://localhost:5000. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. AI generated content irrelavent to the project. Won't work when devs will try to set their system up. |
||
|
||
## 📞 Contact Us | ||
For more information or support, reach out to us at: | ||
|
||
Email: [email protected] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no such email. |
||
Phone: +91 12345 67890 | ||
Website: www.nactocare.com | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No website. |
||
## 🙌 Join Us in Making a Difference! | ||
Together, we can empower nurses, enhance healthcare accessibility, and make a lasting impact on India's healthcare system. Thank you for being a part of Nacto Care! 🌟 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aasthakourav20 Here it says EduWeb project. Please replace it with NactoCare and re-check the docs after pasting.