blood-donate-locator-api

README

🩸
Blood Donate Locator API

An Open source API with worldwide locations where donors are welcome to donate blood or blood plasma.

👀 Prerequisites

Before getting started, make sure you have the following:

• Make sure you have a MongoDB database
• Make sure you have a Keycloak instance for authentication and authorization. Version 21.1.2 or higher is required.
• Make sure you have Go installed (download). Version 1.14 or higher is required.

⚙️ Installation

1. Install dependencies

go mod tidy

1. Create the .env file

# Edit the file to your needs
cp .env.sample .env

⚙️ Keycloak Setup

1. Set up your local Keycloak instance.
2. Import the Keycloak realm configuration:
   • In the Keycloak UI, go to "Realm Settings".
   • Click on the "Action Dropdown" and select "Partial Import".
   • Choose the keycloak-realm-export.json file from the root of this repository.

⚙️ Running the Project

To run the project with live reload, run:

make dev

Uses Air (live reload for Go apps)

🔨 Built With

• Fiber
• Go
• Logrus
• Viper

⚠️ License

1. LICENSE

👷 Roadmap

• App with map view: This would allow users to see the locations of blood donation centers on a map, making it easier for them to find a location that is convenient for them.
• Search functionality: Users should be able to search for blood donation centers by location, such as by city or zip code.
• Filtering options: Users should be able to filter the list of blood donation centers by various criteria, such as by type of donation (whole blood, platelets, etc.), by location (e.g., within a certain distance of their current location), or by other factors such as age or weight requirements.
• Information about each location: The app should provide detailed information about each blood donation center, including its address, hours of operation, and any special requirements or restrictions.
• Appointments: Users should be able to schedule appointments to donate blood at a particular location, either through the app or by contacting the center directly.
• Notifications: The app could send users reminders about upcoming blood drives or other events, or alert them when there is an urgent need for blood donations in their area.