Skip to content
This repository has been archived by the owner on Aug 29, 2018. It is now read-only.

Latest commit

 

History

History
45 lines (28 loc) · 1.76 KB

README.md

File metadata and controls

45 lines (28 loc) · 1.76 KB
Raw

header picture

data.webuild.sg

Dependency Status Build Status

Using data and graphs to inspire variety, openness and projects for the design and engineering community in Singapore

install

  1. clone this repository: git clone git@github.com:webuildsg/data.git
  • install all the required packages with npm i
  • start the website with npm start
  • run all tests and linting with npm test
  • build html file from *.pug templates with npm run build:html
  • build all *.json data to plot graphs with npm run build:graph
  • remove all built files with npm run clean
  • check that all data snapshot files are in the correct format with npm run check

data

A daily scheduler stores the data snapshots for events and repos:

  1. *.json format
  • file name format {type}_archive_YYYY_MM_DD_HHMMSS.json
  • folder data/{type}/v1/{filename} for version compatibility in case there are api changes in the future
  • {type} includes repos or events

check

  1. if the map locations are wrong, check the address here

contribute

This project is an OPEN Open source project.

Please see CONTRIBUTING.md for details.

credits

license

Released under an MIT license