trojblue/SafeMap

one-shot covid geographical intelligence platform; a Hackathon project

SafeMap: one-shot covid-19 intelligence

An awesome hackathon project!
View on Devpost »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Folder Structure
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

SafeMap is a platform that aims to aid people in making daily commute decisions. We do this by integrating available data from various sources into a single point of view. This empowers the users to discover potential risk factors in their daily lives, and reduce exposure to the virus based on real-time risk statistics.

Project Highlights:

• Complete Frontend-Middleware-Backend stack, with RESTful and microservices framework
• Utilized a mix of public and home-grown APIs to get accurate data
• A unique combination of tech stacks for optimized runtime efficiency

Built With

SafeMap is implemented using multiple frameworks, with multiple developers, using various programming languages.

• Frontend: Leaflet.js, D3.js, Bootstrap, JQuery, Google Maps API
• Middleware: Nginx, Flask, Swagger
• Backend: Firebase, NodeJS, Python, Yarn, Google Compute Engine
• Ideation: Figma, Sketch

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Folder Structure

• combined: main folder of operation; merging files and changing functions; used as git /dev branch

• python-xxl: the python KNN recommendation engine, implemented as a microservice

• other folders: status updates and stashes

Prerequisites

You need Node, yarn, python3.8 and the corresponding libraries for the project to run.

Installation

1. Get a Google Map API Key

2. Clone the repo

   git clone https://github.com/Trojblue/SafeMap/

3. Install packages using yarn

   cd combined
   yarn

4. Install python dependencies

   cd ../python-xxl
   pip install -r requirements.txt

Usage

The site can be run hosted or be used as an API service.

To run the repo as a website:

1. run rec.py in /python-xxl
2. run command yarn start in /combined
3. if you are running it in a hosted environment, make sure that ports 3000 and 5000 are open on the server.

For more examples, please refer to the Documentation

Roadmap

We are planning to keep expanding the website, and have long-term maintenance to keep it running. We welcome anyone to open pull request on GitHub, or sponsor our project. Moreover, our data visualization, map systems, and recommendation system are incorporated with with robust query systems for Toronto. We can easily expand our map to serve every city in the world.

Contributing

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

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

License

Distributed under the GPL License. See LICENSE for more information.

Acknowledgements

I want to thank everyone for providing us the opportunity to showcase this product. It's been great fun working on it, and I hope this can the world a little bit better, in this tough situation.