cb-cities/sierra-charlie

Browser based interactive graph visualisation

sierra-charlie

Usage

This project does not include input files. These input files describe the network you wish to visualise, i.e. the roads and junctions. These are required inside the json folder. The schema for these files is found in the json-schema directory.

Easy way - build and run with Docker

This projects come with a Dockerfile which enables the automation of image creation.

cd sierra-charlie

docker build -t "sierra-charlie:latest" .

docker run -ti -p 3000:3000 "sierra-charlie:latest" /bin/bash

$npm start

Point your browser to localhost:3000

Hard way - installing dependencies

Portions of the code are written in PureScript and Elm. Compilers for both languages and the Node.js runtime must be installed on the local machine.

The project is developed on OS X, but may support other UNIX platforms. On OS X, system-level dependencies should be installed with the brew tool.

brew install node purescript

Webpack is used to structure the project, supporting development and production mode builds. ES2015 syntax is translated to JavaScript using Babel. Code quality is monitored using JSHint.

Use yarn tool to install project-level dependencies.

This project was built for elm version 0.16. yarn may be used to install this

yarn add [email protected]

Use yarn to install packages. If you don't have yarn, install it using npm install -g yarn.

yarn install

You will also need to increase the kernel limits on OS X.

sudo bash -c 'echo "kern.maxfiles=65536" >>/etc/sysctl.conf'
sudo bash -c 'echo "kern.maxfilesperproc=65536" >>/etc/sysctl.conf'
echo "ulimit -n 65536" >>~/.bash_profile

This may require you to restart your computer.

Building the project

The same npm tool is also used to build the project, and to simplify other project-related tasks.

To build the project, give the following command:

npm run build

If the build is successful, the project is ready to run. In one session, start a local CORS proxy:

npm run start-proxy

In another session, start a local HTTP server:

npm start

Finally, navigate to the following address in a web browser:

http://localhost:3000

sierra-charlie's Issues

Add JSON Schema

Add dependency checker

Use https://david-dm.org/ dependency checker

Elm 0.16 to 0.17

Blog post covering upgrade - https://github.com/elm-lang/elm-platform/blob/master/upgrade-docs/0.17.md

BFG basemap

OSM for basemap

• Wait on OSM functions.

Add automated build in AWS

Error when building project with docker

Exit code: 1
Command: install-purescript --purs-ver=0.12.0 .
Arguments:
Directory: /usr/local/share/.config/yarn/global/node_modules/purescript
Output:
[ SUCCESS ] Check if a prebuilt 0.12.0 binary is provided for Linux (2s)
[ SUCCESS ] Download the prebuilt PureScript binary (5s)
[ FAILURE ] Verify the prebuilt binary works correctly
Error: Command failed: /usr/local/share/.config/yarn/global/node_modules/purescript/purs.bin --version
/usr/local/share/.config/yarn/global/node_modules/purescript/purs.bin: error while loading shared libraries: libtinfo.so.5: cannot open shared object file: No such file or directory
   at makeError (/usr/local/share/.config/yarn/global/node_modules/execa/index.js:172:9)
   at Promise.all.then.arr (/usr/local/share/.config/yarn/global/node_modules/execa/index.js:277:16)


↓ Fallback: building from source


[ FAILURE ] Check if 'stack' command is available
'stack' command is required for building PureScript from source, but it's not found in your PATH. Make sure you have installed Stack and try again. → https://docs.haskellstack.org/en/stable/install_and_upgrade/#linux
info Visit https://yarnpkg.com/en/docs/cli/global for documentation about this command.
The command '/bin/sh -c yarn global add purescript [email protected]' returned a non-zero code: 1