Skip to content
This repository was archived by the owner on Nov 11, 2022. It is now read-only.

Repository files navigation

Project-9-20

Project 9/20 is the easy way to manage resources for disaster relief efforts in Puerto Rico after hurricane Maria

Overview

Currently the project consist on implementing and testing the backend of an application used to manage resources on a Disaster Site, such as Puerto Rico after hurricane Maria. The data in the application is managed by a relational database system, and exposed to client applications through a REST API. You will build the database application and REST API, which form the backend of the system. Your database engine must be relational, and you must implement the code in either Java, Python, or JavaScript. The backend site will enable the user to browse categories for resources (i.e., water, food, medications, tools, heavy equipment, etc.), search for specific items, specify who is supplying items, and who needs the items. Also, add the location (GPS) and address of the person in need and that of the supplier. The project will eventually include a web-based application wich will be used as a dashboard to manage resources, view statistics among other things.

REST API

Details

We have opted to host our project using Google Cloud App Engine and Google Cloud SQL. Currently you may access the REST API using the base URL:

https://project-9-20-187720.appspot.com/

Entity Relation Diagram

ERD ERD Documentation

Documentation

Resources

Get all resources

https://<baseURL>/resources

Find all resources by keyword

https://<baseURL>/resources/requested/search?keyword=<keyword>

Get all requested resources

https://<baseURL>/resources/requested

Get all available resources

https://<baseURL>/resources/available

Find all available resources by keyword

https://<baseURL>/resources/available/search?keyword=<keyword>

Find all requested resources by keyword

https://<baseURL>/resources/requested/search?keyword=<keyword>

Get all resource categories

https://<baseURL>/resources/category

Find all available resources by name

https://<baseURL>/resources/available?name=<name>

Find all available resources by description

https://<baseURL>/resources/available?description=<description>

Find all available resources by name and description

https://<baseURL>/resources/available?name=<name>&description=<description>

Get all requested resource categories

https://<baseURL>/resources/requested/category

Get all resources requested by category ID

https://<baseURL>/resources/requested/category/<category_id>

Get all resources available by category ID

https://<baseURL>/resources/available/category/<category_id>

Statistics

Get daily statistics of available resources

https://<baseURL>/statistics/daily/resources/available

Get daily statistics of requested resources

https://<baseURL>/statistics/daily/resources/requested

Get daily matching between requested and available resources

https://<baseURL>/statistics/daily/resources/between_requested_available

Get weekly statistics of available resources

https://<baseURL>/statistics/trending/resources/available

Get weekly statistics of requested resources

https://<baseURL>/statistics/trending/resources/requested

Get weekly matching between requested and available resources

https://<baseURL>/statistics/trending/resources/between_requested_available

Get regional statistics of available resources

https://<baseURL>/statistics/trending/resources/available/region/<regionID>

Get regional statistics of requested resources

https://<baseURL>/statistics/trending/resources/requested/region/<regionID>

Get regional matching between requested and available resources

https://<baseURL>/statistics/trending/resources/between_requested_available/region/<regionID>

Users

Account Login

https://<baseURL>/accounts/login?accountid=<accountid>&accountpass=<accountpass>

Get account data

https://<baseURL>/accounts/<userID>

Get all suppliers

https://<baseURL>/accounts/suppliers

Get all suppliers at a specified city

https://<baseURL>/account/suppliers?city=<cityName>

About

Project 9/20 is the easy way to manage resources for disaster relief efforts in Puerto Rico after hurricane Maria

Resources

Stars

2 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages