Backend API application server written in Django + Django REST Framework application to serve disaster data from a postgreSQL database through a REST API.
When run, the application provides an http endpoint on the local system that serves the API via REST. The application can be run in two environments. For the development environment two Docker images that can be built and run are provided. The first image is the API application while the second is the postgreSQL database from which the API application serves data. For production envrionments a single image is provided, intended to allow the API application to be run on a web server instance such as AWS and connect to an existing postgreSQL database as the data source. Once built, the images can be started by running bin/start.sh and specifying either the -d (development) or -p (production) arguments.
Before running the development server application, the database must be restored from a backup file and the Docker images must be built. (Talk to the Disaster Resilience Team if you need to obtain a copy of the database backup file)
- Clone the git repo:
$ cd ~/src
$ git clone [email protected]:hackoregon/disaster-resilience-backend.git
- Copy
disaster.envto.env:
$ cp ./disaster.env ./.env
- Place copy of the disaster database backup in the
Backups/directory. - Execute the start script with
-dto (build and) start the images:
$ bin/start.sh -d
The images will then build for a few minutes. Once the API application has completed starting up, you will see the following message:
Django application has started. Browse to 0.0.0.0:8000 to see the API.
At this point the API is exposed at an endpoint on your local machine; point a client at or browse to 0.0.0.0:8000/api to use/see the API and 0.0.0.0:8000/schema to see the schema. To stop the server and images, press CTRL+C and wait a moment for the images to shut down.
coming soon
master- not usedstaging- deploy to AWSdevelopment- active development
This repo represents the work of many members of the Hack Oregon project team. The roots of this work began with the 2017 backend-service-pattern, the work of the DevOps and platform teams, and the APIs deployed for the 2017 seasons.
The current implementation's application and database docker images were generated from the backend-exemplar-2018 repo, which is based on the transportation-system-backend and passenger_census_api repos. The database structure is an implementation of the PostGIS container from the data-science-pet-containers repo.
- Nathan Miller (nam20485)
- M. Edward (Ed) Borasky (znmeb)
- Moss Drake (mxmoss)
- Brian Grant (bhgrant8, BrianHGrant)
- Mike Lonergan (mikethecanuck)