forked from monsooncollective/yatayat
-
Notifications
You must be signed in to change notification settings - Fork 3
/
README
58 lines (41 loc) · 1.19 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
== HACKING / DEPLOYING
==== submodules
yatayat uses a kdtree implementation from @ubilabs on github; to
use it you will need to run
% git submodule init
% git submodule update
inside your cloned repository
==== config
config.js pulls from a overpass-api directly; to develop locally,
you can symlink config.local.js to config.js, but please be
careful not to commit your symlinked file
% ln -s config.local.js config.js
== Data Model
OSM Data is transformed into Routes, Stops, and Segments:
Route:
- id
- name
- ref // route number
- transport // type of transport; pulled from tag.type
- stops: [] // are ordered
- stopDict: {} // indexed by id
- segments: []
- tag: {}
Stop:
- id
- name
- lat
- lng
- tag: {}
Segment: // mostly useful to rendering and internal fns.
- listOfLatLng: [(lat,lng), ...]
- tag: {}
== API
We define a node.js-based API for external applications to make
high-level queries of public transit data.
% node api.node.js
+ http://localhost:8020/route
Returns all routes and stops as a JSON object.
The API requires that jquery and underscore be installed for node:
% npm install underscore
% npm install jquery