You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

50 lines
1.5 KiB

  1. # Compass
  2. Compass is a GPS tracking server that stores data in [flat files](
  3. ## Setup
  4. In the `compass` directory, copy `.env.example` to `.env` and fill in the details. Install the dependencies with composer.
  5. ## API
  6. After you create a tracking database, you can visit the database's settings page to get a read or write token. These tokens are used with the API to update or retrieve data.
  7. ### Writing
  8. To write to a database, make a POST request in JSON format with the following keys:
  9. `POST /api/input`
  10. * locations - a list of GeoJSON objects
  11. * token - the write token for the database
  12. The GeoJSON objects must have at least one property, "timestamp", which is can be any value that can be interpreted as a date. The object can have any additional properties you wish.
  13. The open source iOS [GPS Logger]( will send data in this format by default.
  14. ### Reading
  15. To read a database, make a GET request with the following keys:
  16. `GET /api/query`
  17. * token - the read token for the database
  18. * date - specify a date to return all data on that day
  19. * tz - timezone string (e.g. America/Los_Angeles) which will be used to determine the absolute start/end times for the day
  20. ## Credits
  21. Compass icon by Ryan Spiering from the Noun Project.
  22. ## License
  23. Copyright 2015 by Aaron Parecki
  24. Compass is licensed under the [Apache 2.0 license](
  25. Compass is built using the Lumen framework, which is licensed under the [MIT license](