Skip to content

To create a centralized communication platform that ensures efficient and equitable distribution of resources during Myanmar flood relief efforts.

License

Notifications You must be signed in to change notification settings

One-Bit-Myanmar/mahar-link

Repository files navigation


Logo

A centralized platform for efficient flood relief coordination in Myanmar.

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments
  8. IoT Device Simulation

About The Project

App Demo

Mahar Link improves communication and coordination among organizations, volunteers, and non-profits in Myanmar flood relief efforts. It prevents redundant supply deliveries to the same location and ensures underserved areas receive necessary resources, providing efficient and effective support.

Mission

To enhance coordination among organizations, volunteers, and non-profits, preventing redundant supply deliveries and ensuring all affected areas receive the necessary support.

Vision

To create a centralized communication platform that ensures efficient and equitable distribution of resources during Myanmar flood relief efforts.

Detailed Documentation

For detailed documentation, please visit Documentation.

IoT Device Simulation

We have also created an IoT device simulation with Arduino for this project. You can find the repository for the simulation here.

(back to top)

Main Features

  • Real-time Communication: Enables real-time communication among organizations, volunteers, and non-profits.
  • Centralized Database: Maintains a centralized database of organizations, volunteers, and resources.
  • Location-based Services: Provides location-based services to identify underserved areas.
  • User Authentication: Secure user authentication and authorization.
  • Push Notifications: Sends push notifications for important updates and alerts.
  • Mobile Accessibility: Accessible via mobile devices for on-the-go coordination.
  • Resource Tracking: Tracks the distribution of resources to prevent redundant deliveries.
  • Data Analytics: Analyzes data to improve resource distribution efficiency.

(back to top)

Built With

  • React
  • Expo
  • Firebase

(back to top)

Getting Started

Follow these steps to set up the project locally.

Prerequisites

Ensure you have the following installed on your machine:

  • Node.js (v14 or later)
  • npm (v6 or later)
  • Expo CLI (for React Native projects)

Installation

  1. Clone the repository:

    git clone https://github.com/One-Bit-Myanmar/mahar-link.git
    cd mahar-link
  2. Install Dependencies

    npm install
  3. Set up Firebase

    • Create a Firebase project at Firebase Console
    • Add a web app to your Firebase project.
    • Copy the Firebase configuration and create a firebaseConfig.js file in the src directory;
    // src/firebaseConfig.js
    const firebaseConfig = {
    apiKey: "YOUR_API_KEY",
    authDomain: "YOUR_AUTH_DOMAIN",
    projectId: "YOUR_PROJECT_ID",
    storageBucket: "YOUR_STORAGE_BUCKET",
    messagingSenderId: "YOUR_MESSAGING_SENDER_ID",
    appId: "YOUR_APP_ID",
    };
    
    export default firebaseConfig;
  4. Start the development server

    npm start
    # or
    npm run android
    # or
    npm run ios
  • Additional Configuration

    • Environment Variables Create a .env file in the root directory and add any necessary environment variables.

(back to top)

Usage

Access the app

  • Open the Expo Go app on your mobile device and scan the QR code displayed in the terminal.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Top contributors:


(back to top)

License

Distributed under the Apache License. See LICENSE.txt for more information.

(back to top)

Contact

One Bit Myanmar - [email protected]

Project Link

Project Type Repository Link
Mobile Application https://github.com/One-Bit-Myanmar/mahar-link
IOT Device https://github.com/One-Bit-Myanmar/IOT-for-weather-mornitoring

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

To create a centralized communication platform that ensures efficient and equitable distribution of resources during Myanmar flood relief efforts.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •