This a simple Django REST API which provides information about customers and integrates with the google maps API
- Django - Django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design.
- Django Rest Framework - Django REST framework is a powerful and flexible toolkit for building Web APIs.
- Python Client for Google Maps Services - This library brings the Google Maps Platform Web Services to your Python application.
- Django Environ - Django Environ allows you to use Twelve-factor methodology to configure your Django application with environment variables.
- Docker - Docker simplifies and accelerates your workflow, while giving developers the freedom to innovate with their choice of tools, application stacks, and deployment environments for each project.
- Docker Compose - Compose is a tool for defining and running multi-container Docker applications.
To be able to use the project follow the steps below.
follow the instructions in the documentation below:
How to get API Key Google Maps
$ docker-compose exec service cp customers/env.template customers/.env
Fill in the necessary information from the .env file for example.
$ docker-compose up -d --build # (only first)
$ docker-compose exec service python3 manage.py migrate # (only first)
$ docker-compose exec service python3 manage.py createsuperuser # (only first)
$ docker-compose exec service python3 manage.py import_customers
$ docker-compose up -d
$ docker-compose exec service bash
$ python manage.py runserver 0.0.0.0:8000
Contributions are what make the open source community an incredible place to learn, inspire and create. Any contribution you make will be much appreciated.
- Fork the project
- Create a Branch for your Feature (
git checkout -b feature/name_branch
) - Add your changes (
git add file
) - Commit your changes (
git commit -m 'Adding an awesome Feature!
) - Push the Branch (
git push origin feature/name_branch
) - Open a Pull Request
The MIT License (MIT)
Copyright (c) [2020] Adson Rodrigues
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Adson Rodrigues - Linkedin