GithubHelp home page GithubHelp logo

libremap / libremap-api Goto Github PK

View Code? Open in Web Editor NEW
10.0 10.0 6.0 1.03 MB

The CouchDB server design document for LibreMap - a scalable, global and decentralized router database and map visualization for community networks, such as guifi, AlterMundi, FunkFeuer, ninux, freifunk, Commotion...

Home Page: http://libremap.net/

License: GNU General Public License v3.0

JavaScript 80.20% Python 19.80%

libremap-api's People

Contributors

mojoaxel avatar nicoechaniz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

libremap-api's Issues

allow nodes with no position (lat,lon) data

I understand that it makes no sence for an map-applikation to render nodes with no location data (lat, lon).
But the libremap-api is not a map applikation. It provides only an API for a collection of wifi nodes.
In the future I want to create simple statistic applikations that show e.g. the count of all online and offline nodes of a specific community. Also graphs like the ffmap-d3 are a nice example what could be done using the libremap-api as backend. For this tasks the position of nodes is not needed at all.

We should change the API in future versions to allow nodes with no position but instead change the map-specific views to simply ignore such nodes.

Old

lat: (required, number) latitude in degrees, range [-90,90], EPSG:3857.
lon: (required, number) longitude in degrees, range [-180,180], EPSG:3857.
elev: (optional, number) elevation in meters above mean sea level.

New

location: { (optional, object)
    lat: (required, number) latitude in degrees, range [-90,90], EPSG:3857.
    lon: (required, number) longitude in degrees, range [-180,180], EPSG:3857.
    elev: (optional, number) elevation in meters above mean sea level.
}

Is this something for version 2.0? What do you thing guys?

pluralize endpoint name(s)

Just skimmed the api documentation [1] and I think you should puralize? the endpoint name for router to api/routers. If there are or will be other endpoints you should also rename them.

A maybe good resource for arguments:

http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api

Maybe it's also worth to think about the routers_by_location resource? Just brain storming:

  • api/bboxes/1/2/3/4 (-1)
  • api/routers?bbox=1,2,3,4 (+1)
  • api/routers?clustered=true
  • api/routers?clustered=true&stripped=true

I understand that this is a very subjective topic but there are some conventions that most people try to follow and maybe we should try to do so too.

Thanks for your ongoing hard work on the topic! Nice work!!!

Best Regards
Philipp

[1] https://github.com/libremap/libremap-api/blob/master/doc-api.md

maintenance script

A maintenance script should be run regularly or as a daemon that

  • initiates a CouchDB database cleanup + compaction.
  • deletes routers from the database that haven't been updated for a while.

In future, such a script could also listen on the database's changes feed and create documents for statistics...

add "system information"

it would be nice to have a object containing system information like the following:

  • number of processes
  • memory usage
  • OS type and version
  • wireless chip revision
  • cpu type
  • loadaverage

simple environment setup

Hi,

I'm embarrassed to say that I got stuck on the first line of the installation instructions

CouchDB server 1.3 (or newer) with the GeoCouch plugin.

Is there a simple way to install CouchDB with the GeoCouch plugin on Ubuntu? I've successfully compiled CouchDB 1.6 from scratch but attempts to pull the latest GeoCouch repo and compile generates errors and fixing one only seems to reveal others. Am I doing something wrong? Should I be using an earlier version of CouchDB?

add 'alias_local' into links

Currently, there's no way to determine to which local alias is associated with a link. Thus, I suggest to add a mandatory alias_local field into each link object, e.g.

"links": [
    {
      "alias": "52:23:61:a7:a1:56",
      "alias_local": "ca:ff:ee:51:34:21",
      "type": "batman-adv",
      "quality": 0.78
    },
    ...
]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.