Neighborhood Simulacrum

Open Data Community Indicators Platform

Links

API
OpenAPI Schema
Documentation ( Swagger UI | Redoc)

System Requirements

1. Python (^3.8)
2. PostgreSQL (^11)
3. Postgis
4. pip
5. Probably a bunch of other stuff I mistakenly take for granted. Let me know.

Installation

0. Create a Postgres database with the PostGIS extension added.
1. Clone this code

git clone https://github.com/WPRDC/neighborhood-simulacra

2. Enter the project directory

cd neighborhood-simulacrum

3. Create a virtual environment and activate it (docs)

# make it
$ python3 -m venv env

# activate it
$ . env/bin/activate

4. Install required python packages

$ pip install -r requirements.txt

5. Modify profiles/local_settings.py.example based on the instructions therein.

6. Configure the database using the projects migrations.

$ ./manage.py migrate

7. Follow the extra initialization instructions in init/ to set up the tile server and CKAN connection.

8. Run your server! 🚀

$ ./manage.py runserver

Your api will be available at http://localhost:8000/api
Your admin interface will be available at http://localhost:8000/admin

Useful Resources / External Docs

Django

The web framework that the project is built on.

Django REST Framework

We use the tools from DRF to define our web API.

GeoDjango Documentation

Since we deal with a lot of geographic data, we use a lot of the geographic tools in Django.

Django Polymorphic

Django polymorphic provides utility classes for standardizing interfaces to polymorphic data models.