Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/topogram/topogram

Explore how networks change over time
https://github.com/topogram/topogram

collaboration geospatial meteor network-analysis topogram

Last synced: 14 days ago
JSON representation

Explore how networks change over time

Awesome Lists containing this project

README

        

# Topogram

**Topogram** is a web-based app to visualize the evolution of networks over time and space.

[![Build Status](https://travis-ci.org/topogram/topogram.svg?branch=api)](https://travis-ci.org/topogram/topogram)

For more information, please [read the docs ](http://topogram.io)

## Features

* time-based navigation in graph
* network layouts + geographic data
* online/real-time data update via API

![Screenshot Topogram](http://topogram.io/img/Topogram-Network.png)

## Download & Install

You need [Meteor JS](https://www.meteor.com/) to install Topogram.

git clone https://github.com/topogram/topogram-client.git
cd topogram-client
meteor npm install
meteor

### Test & Code quality

There is 2 sorts of tests here :

1. functional tests for the components in `/tests`
2. integration tests for the Meteor app located in ```specs```.

You can launch all tests using `gulp test` or `npm test`

You can also run the app in test mode to check integration as you develop

npm test:meteor

Check for ESlint compliance

npm run lint

### Deploy with Docker

You can use Docker to run in production.

1. build the Docker topogram/topogram container with `./build.sh`
1. fetch a mongo Docker container for the DB and run the app with `docker-compose up`

### Build the docs

All the docs will be built in the `.docs/` folder.

gulp doc

### Publishing instructions

This project is set up to automatically publish to npm. To publish:

1. Set the version number environment variable: export VERSION=1.2.3
1. Publish: ```gulp publish```

### Internationalization

Topogram supports internationalization. Please read our [i18n guidelines](https://github.com/topogram/topogram/wiki/App-translation) and feel free to add your own language by translating a file in `./i18n` folder!