Skip to content

README.md

Latest commit

 

History

History
81 lines (57 loc) · 2.09 KB

README.md

File metadata and controls

81 lines (57 loc) · 2.09 KB

PharMatch

PharMatch is an intelligent platform designed to help users locate the nearest pharmacies, interact with an AI assistant for medical questions, check the availability of medicines, and much more.

🚀 Features

  • Pharmacy Locator: Find the closest pharmacies based on your location.
  • AI Medical Assistant: Ask health-related questions and get quick, informed responses.
  • Medicine Availability: Check if specific medicines are in stock at nearby pharmacies.
  • User-Friendly Interface: Accessible from web or mobile devices.
  • Multi-language Support: Designed with accessibility in mind (French, English, etc.).
  • Secure Data Handling: User privacy and security are top priorities.

🛠️ Tech Stack

  • Frontend: React with Typescript
  • Backend: Node.js, Express
  • Database: MongoDB
  • AI Integration: OpenRouter API , Google map
  • Maps & Geolocation: Google Maps API
  • Transaltion : i18next

📦 Installation

  1. Clone the repository:

    git clone https://github.com/Alae-ELO/PharMatch.git
cd PharMatch

  2. Install dependencies:

    # For backend
cd pharmatch-be
npm install

# For frontend (if applicable)
cd ../pharmatch-fe
npm install

  3. Configure environment variables:

    • Copy .env.example to .env in each project directory and update with your settings.

  4. Run the development server(s):

    # Backend
npm start

# Frontend
npm start

🖥️ Usage

  • Access the web interface at http://localhost:5000 (or your configured port).
  • Use the search to find pharmacies, ask questions to the AI, or check medicine availability.

🤝 Contributing

Contributions are welcome! To propose a feature, report a bug, or suggest improvements:

  1. Fork this repository
  2. Create a branch: git checkout -b feature/YourFeature
  3. Commit your changes: git commit -m "Add your feature"
  4. Push to the branch: git push origin feature/YourFeature
  5. Open a Pull Request

📝 Notes

  • This project is in active development.