Certainly! Below is a README.md template for your healthcare management, appointment, and consultation platform "Eres" built for the "Hack This Fall" hackathon. It includes all the necessary steps to run the project and other instructions as you mentioned:
Eres is a healthcare management platform designed to facilitate appointment bookings and consultations seamlessly. The app allows users to manage appointments, access consultation records, and interact with healthcare providers, all while ensuring a smooth experience using blockchain technology for secure transactions and interactions.
This project was built as part of the Hack This Fall hackathon.
A demo video showcasing the features and functionality of the Eres platform can be viewed here on Devfolio.
- Healthcare Management: Keep track of appointments, consultations, and patient records.
- Appointment Booking: Users can easily book appointments with healthcare providers.
- Consultation: Secure video or chat consultation with doctors and healthcare professionals.
- Blockchain Integration: Ethereum integration for secure interactions and transactions.
- Privacy: It ensures privacy of the details of every patient and patient can have compelete reliablility on this system
Before running the project, ensure that you have the following installed:
- Node.js (version 18.17.1 or 18.17.2 for compatibility with Hardhat).
- NVM (Node Version Manager) for switching Node versions easily.
- Metamask Chrome Extension for Ethereum wallet integration with the app.
- Hardhat for Ethereum development and smart contract testing.
First, clone the repository:
git clone https://github.com/thebinary110/eres.git
cd eresInstall the necessary packages using npm:
npm installEnsure that your Node.js version is compatible with Hardhat. If your Node.js version is higher than v18.17.2, you will need to use nvm (Node Version Manager) to switch to version v18.17.1 or v18.17.2.
-
Install nvm (if not already installed):
- For Mac/Linux:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash - For Windows, use nvm-windows.
- For Mac/Linux:
-
Install the required Node.js version:
nvm install 18.17.1
-
Set the version to v18.17.1:
nvm use 18.17.1
Hardhat is used to simulate an Ethereum blockchain network on your local machine.
- Start the Hardhat local Ethereum node:
npx hardhat node
This will start a local Ethereum node, and you should see something like this in the terminal:
Hardhat local network started on http://localhost:8545To configure your Ethereum network on Metamask, follow these steps:
-
Open Metamask in your Chrome browser.
-
After configuring the network, import the accounts generated by Hardhat into Metamask:
- You will see private keys in the terminal when you start the Hardhat node. Use those private keys to import accounts into Metamask.
Ensure that the image paths in the project correspond to your system's file structure. Update the paths in the relevant files to point to the correct locations on your local machine.
For example, if your images are located in a directory called public/, you may need to update the image paths in your code:
const imagePath = "/public/images/your-image.jpg";
Adjust the path according to your project's file structure.
---
### 6. **Run the App Locally**
To run the app on your local machine, start the development server:
```bash
npm run dev
This will start the app at http://localhost:3000.
-
Frontend:
- React.js
- CSS/SCSS for styling
- Web3.js for Ethereum interaction
-
Backend:
- Node.js
- Hardhat for Ethereum development
-
Blockchain:
- Ethereum (local Hardhat network)
-
Other:
- Metamask for wallet integration
This project is open source and available under the MIT License.
Feel free to open issues or submit pull requests if you have any suggestions or improvements for this project.
- Hack This Fall for organizing the hackathon.
- Metamask for providing a great wallet solution for Ethereum.
- Hardhat for making Ethereum smart contract development seamless.
Let me know if you need any further changes or additional details!