django-points

Django Coordinates // Distance between coordinates

Django Co-ordinates API

About The Project

An application that should have an API endpoint that accepts a string of comma separated points for example “(2,3), (1,1), (5, 4), ...” and calculates the closest points. It then stores them in a table with the following details:

• The string of points submitted
• The result of the computation: the closest points pair

Here are some of the features:

• Input Points and create closest two coordinates

Built With

• Django
• Python
• PostgresQl

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

1. Access Github https://github.com

2. Clone the repo

   git clone https://github.com/lupamo3/django-points/tree/master

3. Change directory into the Django points directory :

   cd django-points

4. Create and activate your virtual environment :

   Virtual venv python=[Python-Version]
   Pip install auto-env

5. Install Project Requirements

pip install -r requirements.txt

6. Run the application

python3 manage.py runserver

7. Run tests

python3 manage.py test

Test the application on Postman

Test The API end-points

• Run Co-ordinates Endpoints on your postman to test the URLs

or use:

URL	METHOD	MESSAGE
points/	POST	Input an Array and number of points.

---

Additional Information

• Feel free to reach me via email and to fork this project
  • Any feedback would be appreciated.
  • The Pull requests have bit by bit application documentation

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Contact

Your Name - @nlanjichi

Project Link: https://github.com/lupamo3/django-points