Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 2 KB

README.md

File metadata and controls

65 lines (47 loc) · 2 KB
Raw

Trekkie

built with nix

Contact: [email protected]

This service takes your GPS tracks and times and regenerates the position mapping.

Usage

graph TD
    A[Start] -->|/user/login| B(Authenticated)
    A[Start] -->|/user/create| B(Authenticated)
    B -->|/travel/submit/run| C(Upload Measurement Intervals)
    C -->|/travel/submit/gpx| D(Travel created & GPX Uploaded)
    D --> E(Done)
Loading

The POST /user/create endpoint will create a simple user and return the user_id and password which should be saved persistently, because they are required to authenticate against the /user/login endpoint.

Uploading a track is a two stage process the first is submitting the Run Information to /travel/submit/run. The second part is uploading the GPX File with the /travel/submit/gpx endpoint this endpoint requires the user to specify the corresponding run id.

API Endpoints

For the full OpenAPI spec take a look at the swagger.yaml in this repository.

  • POST /user/create creates simple trekkie user and returnes token/password back to the user
  • POST /user/login takes the user id and password to set a authentication token
  • POST /travel/submit/gpx takes multipart for uploading gps file this will return an id for this file
  • POST /travel/submit/run uploads the measurement intervals with the gps file id.

Building & Deployment

    $ nix build

Environment Variables

  • TREKKIE_REDIS_HOST
  • TREKKIE_REDIS_PORT
  • TREKKIE_POSTGRES_HOST
  • TREKKIE_POSTGRES_PORT
  • TREKKIE_POSTGRES_USER
  • TREKKIE_POSTGRES_DATABASE
  • TREKKIE_POSTGRES_PASSWORD_PATH
  • SALT_PATH

Command Line

gps track collection server

Usage: trekkie [OPTIONS]

Options:
  -a, --api-host <API_HOST>  [default: 127.0.0.1]
  -p, --port <PORT>          [default: 8080]
  -s, --swagger
  -h, --help                 Print help information
  -V, --version              Print version information