Skip to content

bitnik/binder-launches

Repository files navigation

This repo contains

  1. a script to parse binder launch events and save into TimescaleDB
  2. a frontend to visualize launches using React with Material-UI which is backed by Express.js

An instance is running at GESIS Notebooks: https://notebooks.gesis.org/binderlaunches/

Helm chart

If you want to install it as helm chart, have a look at the documentation for helm chart.

Local development

  1. First you have to set up and run the parser, so that you have some data to visualize.
  2. Install the Node.js version 15.12.0. For that you can use the nvm (node version manager): https://github.com/nvm-sh/nvm#installing-and-updating
# once nvm is installed and ready
# https://github.com/nvm-sh/nvm#usage
# insall node v15.12.0
nvm install 15.12.0
# use the installed node version
nvm use 15.12.0
# check if you are using the right version
node --version
  1. Install JS packages with npm install
  2. Configure the express.js server app. To do that create a config.js file under server directory. Currently there are only 3 configs, here is an example:
const config = {
 port: 3001,
 debug: true,
 // db url is required
 db: 'postgres://username:password@host:port/database'
};

module.exports = config;
  1. Start the node server with npm run start-server
  2. Start the react app in dev mode with npm run start-client and then it will be available at http://localhost:3000