https://github.com/realslimshanky/geo-json-with-django

A Django REST application to showcase use of GeoJSON
https://github.com/realslimshanky/geo-json-with-django

Last synced: 19 days ago
JSON representation

A Django REST application to showcase use of GeoJSON

• Host: GitHub
• URL: https://github.com/realslimshanky/geo-json-with-django
• Owner: realslimshanky
• Created: 2018-08-30T09:24:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-31T21:09:04.000Z (over 6 years ago)
• Last Synced: 2024-11-17T06:56:48.903Z (2 months ago)
• Language: Python
• Homepage:
• Size: 108 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
Geo JSON with Django

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

__Version:__ 0.0.0

This project showcases use of GeoJSON in Django environment.

## Description

Imagine a scenario where there are multiple service providers and their respective service regions which is bounded by list of longitude and latitudes. A person can easily find all the service provider in the region by simply using a longitude and latitude pair.

A provider can signup using `/api/auth` endpoints and register service regions using `/api/service` endpoints. A person can search for service regions in their respective longitude and latitude using `api/service/search` endpoint. For detailed description on how to use these endpoints please read [API Endpoints Doc](docs/api/endpoints.md) 

## Getting up and running

Minimum requirements: **pip, fabric, python3 & [postgres][install-postgres]**, setup is tested on Mac OSX only.

```

brew install postgres python3

[sudo] pip install fabric

```

[install-postgres]: http://www.gotealeaf.com/blog/how-to-install-postgresql-on-a-mac

In your terminal, type or copy-paste the following:

    git clone [email protected]:realslimshanky/geo-json-with-django-web.git; cd geo-json-with-django-web; fab init

Go grab a cup of coffee, we bake your hot development machine.

Useful commands:

- `fab serve` - start [django server](http://localhost:8000/)

- `fab deploy_docs` - deploy docs to server

- `fab test` - run the test locally with ipdb

**NOTE:** Checkout `fabfile.py` for all the options available and what/how they do it.

## Deploying Project

The deployment are managed via travis, but for the first time you'll need to set the configuration values on each of the server.

Check out detailed server setup instruction [here](docs/backend/server_config.md).

## How to release Geo JSON with Django

Execute the following commands:

```

git checkout master

fab test

bumpversion patch  # 'patch' can be replaced with 'minor' or 'major'

git push origin master

git push origin master --tags

git checkout qa

git rebase master

git push origin qa

```

## Contributing

Golden Rule:

> Anything in **master** is always **deployable**.

Avoid working on `master` branch, create a new branch with meaningful name, send pull request asap. Be vocal!

Refer to [CONTRIBUTING.md][contributing]

[contributing]: http://github.com/realslimshanky/geo-json-with-django-web/tree/master/CONTRIBUTING.md