YaPeL/dcr-be

Degree Confluence Rebirth Back end

________                                     _________                _____.__                                     __________      ___.   .__         __  .__      __________               __                       .___
\______ \   ____   ___________  ____  ____   \_   ___ \  ____   _____/ ____|  |  __ __  ____   ____   ____  ____   \______   \ ____\_ |__ |__________/  |_|  |__   \______   _____    ____ |  | __   ____   ____   __| _/
 |    |  \_/ __ \ / ___\_  __ _/ __ _/ __ \  /    \  \/ /  _ \ /    \   __\|  | |  |  _/ __ \ /    \_/ ____/ __ \   |       __/ __ \| __ \|  \_  __ \   __|  |  \   |    |  _\__  \ _/ ___\|  |/ / _/ __ \ /    \ / __ | 
 |    `   \  ___// /_/  |  | \\  ___\  ___/  \     \___(  <_> |   |  |  |  |  |_|  |  \  ___/|   |  \  \__\  ___/   |    |   \  ___/| \_\ |  ||  | \/|  | |   Y  \  |    |   \/ __ \\  \___|    <  \  ___/|   |  / /_/ | 
/_______  /\___  \___  /|__|   \___  \___  >  \______  /\____/|___|  |__|  |____|____/ \___  |___|  /\___  \___  >  |____|_  /\___  |___  |__||__|   |__| |___|  /  |______  (____  /\___  |__|_ \  \___  |___|  \____ | 
        \/     \/_____/            \/    \/          \/            \/                      \/     \/     \/    \/          \/     \/    \/                     \/          \/     \/     \/     \/      \/     \/     \/ 

Configuration

make Sure you edited the .env file with the correct GMAP_API_KEY

Running the code

You should have docker and docker compose installed. When starting, the application will search for a .env file.

To start you development environment just run :

  docker-compose up

Or if you want to run the container in detached mode:

  docker-compose up -d

To stop it:

  docker-compose down

Running the tests

  virtualenv env/
  source env/bin/activate
  pip install -r test-requirements.txt
  pytest app/

Why FastApi

it's like flask, but support async/await out of the box, and I always wanted to try it out, I like it :)

docs

visit http://localhost:5000/docs#/

Future plans, what is missing

• Currently, I generate the nearby points using heuristics, a better approach would be to rip all the valid points from the original project, and store them in a database, probably PostGIS, benefits: ** We can get nearby points using a distance radio, currently, at the poles, the max distance between them is 2 km, but is around 100 km at the Equator ie: using my method you will always get at max, 5 points, using a radio, you should get more the further away you get from the Equator ** Since we can store previous request, we can use the db as a cache instead of dealing with Gmaps (saving money!)
• More tests!
• While most of the integer points are going to fall in the middle of nowhere, some rare cases may end up in a city so implementing the other endpoint to reverse information from a point could be useful, caching could still be used, but we should be aware of when we need to invalidate it
• the geo/nearby endpoint has too much responsibilities, it could be splitted into 2 endpoints, get nearby points, get distance between points, I was aware of this from the start, but did it this way to save time
• the infoMark text should not be coming from the backend.
• Add metric and imperial system for distances.
• Improve swagger documentation