Giter Club home page Giter Club logo

drf_geodjango_api's Introduction

๐Ÿš€ GeoDjango Backend Project ๐ŸŒ

GeoDjango Backend Project is a RESTful API service built with Django REST Framework. It enables transportation providers to define and alter their service areas dynamically as custom polygons.

๐Ÿ›  Tech Stack

  • ๐Ÿ Python
  • ๐Ÿ”ต Django REST Framework
  • ๐ŸŒ GeoDjango
  • ๐ŸŒฑ Celery
  • ๐Ÿ˜ PostgreSQL
  • ๐Ÿ”บ PostGIS
  • ๐Ÿ“ฆ Docker
  • โ˜๏ธ AWS (Optional for deployment)

๐ŸŒŸ Highlights

  • CRUD operations for Providers and Service Areas
  • Efficient querying of service areas by latitude/longitude pair
  • Unit tests to ensure API functionality
  • Comprehensive API documentation
  • Deployed on AWS for real-world testing

๐Ÿš€ Getting Started

  1. Clone the repo
git clone [email protected]:JuniorGunner/drf_geodjango_api.git
cd drf_geodjango_api
  1. Setup Environment Variables Create a .env file in the root directory and setup your environment variables. Example:
POSTGRES_USER=postgres
POSTGRES_PASSWORD=yourpassword
POSTGRES_DB=geodjango_db
  1. Start the project
docker-compose up --build -d

๐Ÿ“˜ API Endpoints

  • POST /providers - Add a new provider
  • GET /providers - Get all providers
  • GET /providers/:id - Get a provider by ID
  • PUT /providers/:id - Update a provider by ID
  • DELETE /providers/:id - Delete a provider by ID
  • POST /service_areas - Add a new service area
  • GET /service_areas - Get all service areas
  • GET /service_areas/:id - Get a service area by ID
  • PUT /service_areas/:id - Update a service area by ID
  • DELETE /service_areas/:id - Delete a service area by ID
  • GET /service_areas/query?lat=:latitude&lng=:longitude - Query service areas by latitude and longitude

drf_geodjango_api's People

Contributors

juniorgunner avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.