move config.js from lib to root
This commit is contained in:
parent
0caaa8f64e
commit
c48f053619
1
.gitignore
vendored
1
.gitignore
vendored
@ -2,3 +2,4 @@ bower_components/
|
|||||||
node_modules/
|
node_modules/
|
||||||
build/
|
build/
|
||||||
.sass-cache/
|
.sass-cache/
|
||||||
|
config.js
|
||||||
|
31
README.md
31
README.md
@ -28,11 +28,32 @@ Meshviewer is a frontend for
|
|||||||
npm install
|
npm install
|
||||||
bower install
|
bower install
|
||||||
|
|
||||||
# Building
|
# Configure
|
||||||
|
|
||||||
You may want to tweak `lib/config.js` to point to your data files. If it's
|
Copy `config.js.example` to `config.js` and change it to match your community.
|
||||||
served from a different domain, remember to [enable CORS] on your
|
|
||||||
webserver. Enabling GZip will reduce bandwidth consumption.
|
## dataPath (string)
|
||||||
|
|
||||||
|
`dataPath` must point to a directory containing `nodes.json` and `graph.json`
|
||||||
|
(both are generated by
|
||||||
|
[ffmap-backend](https://github.com/ffnord/ffmap-backend)). Don't forget the
|
||||||
|
trailing slash! Data may be served from a different domain with [CORS enabled].
|
||||||
|
Also, GZip will greatly reduce bandwidth consumption.
|
||||||
|
|
||||||
|
## siteName (string)
|
||||||
|
|
||||||
|
Change this to match your communities' name. It will be used in various places.
|
||||||
|
|
||||||
|
## mapSigmaScale (float)
|
||||||
|
|
||||||
|
This affects the initial scale of the map. Greater values will show a larger
|
||||||
|
area. Values like 1.0 and 0.5 might be good choices.
|
||||||
|
|
||||||
|
## showContact (bool)
|
||||||
|
|
||||||
|
Setting this to `false` will hide contact information for nodes.
|
||||||
|
|
||||||
|
# Building
|
||||||
|
|
||||||
Just run:
|
Just run:
|
||||||
|
|
||||||
@ -40,4 +61,4 @@ Just run:
|
|||||||
|
|
||||||
This will generate `build/` containing all required files.
|
This will generate `build/` containing all required files.
|
||||||
|
|
||||||
[enable CORS]: http://enable-cors.org/server.html
|
[CORS enabled]: http://enable-cors.org/server.html
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
define(["config", "moment", "router", "leaflet", "gui", "numeral"],
|
define(["../config", "moment", "router", "leaflet", "gui", "numeral"],
|
||||||
function (config, moment, Router, L, GUI, numeral) {
|
function (config, moment, Router, L, GUI, numeral) {
|
||||||
return function () {
|
return function () {
|
||||||
function handleData(data) {
|
function handleData(data) {
|
||||||
|
Loading…
Reference in New Issue
Block a user