https://github.com/abarto/tracker_project

A simple geo-located incident tracking Django application
https://github.com/abarto/tracker_project

Last synced: about 2 months ago
JSON representation

A simple geo-located incident tracking Django application

• Host: GitHub
• URL: https://github.com/abarto/tracker_project
• Owner: abarto
• License: mit
• Created: 2015-02-22T22:34:00.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-03-04T13:41:21.000Z (almost 9 years ago)
• Last Synced: 2024-07-31T19:16:02.691Z (5 months ago)
• Language: Python
• Size: 86.9 KB
• Stars: 56
• Watchers: 8
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

• my-awesome-starred - tracker_project - A simple geo-located incident tracking Django application (Python)

README

        
===============

tracker_project

===============

A simple Django project to report and track geo-located incidents within certain areas of interest. Whenever a new incident occurs the user is reported in real-time and the event is marked in a map (using `Google Maps JavaScript API `_). It's is possible to report the locations manually, but there's also a view that uses the `geolocator `_ library to automatically detect the user's location.

This project created to demonstrate how to use `GeoDjango `_ and send real-time notifications using `gevent-socketio `_ and `RabbitMQ `_. For an in depth description of the project see the following `blogpost `_.

The default configuration uses `PostgreSQL `_ with the `PostGIS `_ extensions as database back-end, but it can also work with other GeoDjango compatible databases like `SQLite `_ + `SpatiaLite `_.

Update #2

=========

I've created yet another implementation of the project using `Django channels `_ for the real-time notifications. You can check it out in the `use-django-channels `_ branch.

Update

======

Some people asked me about a Node.js+socket.io (instead of the gevent-socketio) implementation of the project, so I created a `node_js `_ branch for it.

Requirements

============

Before you can run this project, the following packages need to be installed:

Ubuntu

------

* python-dev

* postgresql

* postgresql-server-dev-all

* postgis

* python-virtualenv

* libevent-dev

* rabbitmq-server

Fedora

------

* python-devel

* postgresql-server

* libpqxx-devel

* postgis

* python-virtualenv

* libevent-devel

* rabbitmq-server

Installation

============

Clone the repository: ::

    $ git clone [email protected]:abarto/tracker-project.git

Create and activate the virtual environment: ::

    $ cd tracker-project/

    $ virtualenv venv/

    $ . venv/bin/activate

Install the requirements: ::

    (venv)$ pip install -r requirements.txt

Initialize nodeenv, and install bower: ::

    (venv)$ nodeenv -p

    (venv)$ npm install -g bower

Create the database and the database user, install the PostGIS extensions: ::

    $ sudo -u postgres psql

    postgres=# CREATE ROLE tracker_project LOGIN PASSWORD 'tracker_project' NOSUPERUSER INHERIT NOCREATEDB NOCREATEROLE NOREPLICATION;

    postgres=# CREATE DATABASE tracker_project WITH OWNER = tracker_project;

    postgres=# \connect tracker_project;

    postgres=# CREATE EXTENSION postgis;

Initialize the database and set-up the Django environment: ::

    (venv)$ cd tracker_project/

    (venv)$ python ./manage.py migrate

    (venv)$ python ./manage.py bower_install

At this point it is possible to run the development server by using the special socketio_runserver management command ::

    (venv)$ python ./manage.py socketio_runserver

If you want to run in it in a production environment. Follow the instructions of the next section.

Running the application

=======================

The application can be run using `Chaussette `_, with the ``socketio`` backend: ::

    (venv)$ chaussette --backend socketio --port 8000 tracker_project.wsgi.application

Please notice that the application won't server the static files, so before you can start using it, you need to run the ``collectstatic`` management command: ::

    (venv)$ python ./manage.py collectstatic

and then use a regular HTTP server like `nginx `_ (we've included a sample configuration file) to server the files.

You can also use socket and process managers like `Circus `_ or `Supervisor `_.

Vagrant

-------

A `Vagrant `_ configuration file is included if you want to test the project.

Acknowledgements

================

The basic architecture for the notifications system follows the guidelines presented by Jeremy West in the blogpost `Django, Gevent, and Socket.io `_. We also used the code for his `socketio_runserver `_ management command.