/Squirrel-Project

database model migration and web deployment

Primary LanguageJavaScript

Squirrel Tracker Project

  • Group Name: Project Group 85
  • Tools For Analytics (Section: 2)
  • Contributors: Yongyi(Nikki)Zhao, Jieming Bian
  • UNI: yz3706 ; jb4382

Overview

Squirrel Tracker is a web application project which provides the users with the visualized sightings of squirrels on the map around Central Park at Manhattan, NYC. Specifically, it can import squirrel data and allows end users to add, update and edit data.

API Link

Details

  • Management Commands

    • Import: A command that can be used to import the data from the 2018 census file (in CSV format). The file path should be specified at the command line after the name of the management command. 

    python manage.py import_squirrel_data /path/to/file.csv

    Export: A command that can be used to export the data in CSV format. The file path should be specified at the command line
    after the name of the management command.

    python manage.py export_squirrel_data /path/to/file.csv

  • Views

    1. A view that shows a map that displays the location of the squirrel sightings on an OpenStreets map

      Located at: /map

Method: GET

    2. A view that lists all squirrel sightings with links to edit and add sightings

      Located at: /sightings

Method: GET

    3. A view to update a particular sighting

       Located at: /sightings/

 Method: POST

    4. A view to create a new sighting

       Located at: /sightings/add

 Method: POST

    5. A view with general statistics about the sightings

       Located at: /sightings/stats

Method: GET

Data Source

We use squirrel data 2018 Central Park Squirrel Census which was counted by the Squirrel Census.

Requirements

  • Python (3.6, 3.7)
  • Django (2.2)

Reference Matrial

Discussion and Development

Most development discussion is taking place on github in this repo.

Contributing to Squirrel Tracker

This is a semester project dedicated for IEOR 4501 Tools for Analytics. Any contributions, bug reports, bug fixes, documentation improvements, enhancements to make this project better are warmly welcomed.