meshviewer/README.md

64 lines
3.2 KiB
Markdown
Raw Normal View History

2017-02-12 18:01:19 +00:00
# Meshviewer
[![Build Status](https://img.shields.io/travis/ffrgb/meshviewer/develop.svg?style=flat-square)](https://travis-ci.org/ffrgb/meshviewer)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/ffrgb/meshviewer/develop.svg?style=flat-square)](https://scrutinizer-ci.com/g/ffrgb/meshviewer/?branch=develop)
2017-03-14 19:21:21 +00:00
[![Documentation](https://img.shields.io/badge/gitbooks.io-documentation-brightgreen.svg?style=flat-square)](https://meshviewer.gitbooks.io/documentation/content/)
2017-02-12 18:01:19 +00:00
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg?style=flat-square)](https://www.gnu.org/licenses/agpl-3.0)
2015-04-01 15:49:12 +00:00
2017-02-27 05:52:16 +00:00
A web-app to visualize nodes and links on a map for Freifunk open mesh network.
2015-04-01 15:07:04 +00:00
2017-02-12 18:01:19 +00:00
#### Main differences to https://github.com/ffnord/meshviewer
_Some similar features might have been implemented/merged_
2017-02-23 21:32:25 +00:00
- Forcegraph rewrite with d3.js v4
2017-02-12 18:01:19 +00:00
- Map layer modes (Allow to set a default layer based on time combined with a stylesheet)
2017-02-18 23:40:26 +00:00
- Automatic updates for selected node or list (incl. image stats cache-breaker)
- Node filter
2017-02-27 05:52:16 +00:00
- Zoom level for clicking on a node (`nodeZoom`) is definable independently from the maximum zoom level 22
2016-05-22 20:35:23 +00:00
- Formatted Code
2017-02-06 23:27:58 +00:00
- Translation support - https://crowdin.com/project/meshviewer - Contact us for new languages
2017-02-19 16:54:02 +00:00
- Currently available: en, de, fr & ru
2016-05-22 20:35:23 +00:00
- Grunt inline for some css and js - less requests
2017-02-12 18:01:19 +00:00
- Icon font with needed icons only
2017-02-18 23:40:26 +00:00
- Grunt upgraded to v1.x (Tested with Node.js 4/6 LTS, 7 on Linux, 7 OSX & W**)
- css and some js moved inline
- Yarn/npm in favour of bower
2017-02-12 18:01:19 +00:00
- Load only moment.js without languages (Languages are included in translations)
2017-03-09 23:53:23 +00:00
- unneeded components removed (es6-shim, tablesort, numeraljs, leaflet-providers, jshashes, chroma-js)
2017-02-27 05:52:16 +00:00
- RBush v2 - performance boost in last versions (positions, labels and clients on the map)
2017-02-18 23:40:26 +00:00
- Ruby dependency removed
2016-05-26 16:39:26 +00:00
- FixedCenter is required
2017-02-27 05:52:16 +00:00
- Sass-lint, scss and variables rewritten for easy customizations/adjustments
2017-02-18 23:40:26 +00:00
- Cross browser/device support improved (THX@BrowserStack)
- Leaflet fork with a patch to avoid IE/Edge crashes
2017-02-27 05:52:16 +00:00
- Yarn package manager in favour of npm (npm still works)
- Configurable reverse geocoding server
2017-02-12 18:01:19 +00:00
- [A lot more in the commit history](https://github.com/ffrgb/meshviewer/commits/develop)
2017-03-14 19:21:21 +00:00
### Demo
2015-04-11 11:48:16 +00:00
2017-02-27 05:52:16 +00:00
Embedded: https://regensburg.freifunk.net/netz/karte/
2017-02-12 18:01:19 +00:00
Standalone: https://regensburg.freifunk.net/meshviewer/
2017-03-14 19:21:21 +00:00
## Documentation
2017-03-14 19:21:21 +00:00
Documentation moved to [meshviewer.gitbooks.io](https://meshviewer.gitbooks.io/documentation/content/).
2015-04-01 15:07:04 +00:00
2017-03-14 19:21:21 +00:00
- Read: https://meshviewer.gitbooks.io/documentation/content/
- PDF, Mobi, ePub & edit: https://www.gitbook.com/book/meshviewer/documentation/details
2015-04-01 15:07:04 +00:00
2017-03-14 19:21:21 +00:00
#### Why move the documentation?
2015-03-29 00:09:21 +00:00
2017-03-14 19:21:21 +00:00
- Search available
- Multiple pages
- Less doc commits, faster changes
- Export as PDF, Mobi, ePub
2016-06-03 20:08:12 +00:00
## Sponsoring / Supporting
2017-03-14 19:21:21 +00:00
2017-02-12 18:01:19 +00:00
- [BrowserStack](https://www.browserstack.com/) for providing an awesome testing service for hundreds of browsers
- [Travis CI](https://travis-ci.org/) for building meshviewer on every push and pull request
- [Scrutinizer CI](https://scrutinizer-ci.com/g/ffrgb/meshviewer/) for testing code quality on every push and pull request
- [Crowdin](https://crowdin.com/) for providing an easy non-developer translation environment
2016-06-03 20:08:12 +00:00
2017-02-12 18:01:19 +00:00
These tools need a lot of infrastructure and provide a free account for open source software.