Skip to content
This repository has been archived by the owner on Apr 24, 2020. It is now read-only.

SoftwareForScience/jiskefet-ui

Repository files navigation

Jiskefet UI

Build Status

Description

This bookkeeping system is a system for A Large Ion Collider Experiment (ALICE) to keep track of what is happening to the data produced by the detectors. The electric signals produced by the various detectors which together are the ALICE detector are being reconstructed, calibrated, compressed and used in numerous but specific ways. It is important to register
how this is done to make a reproduction of data possible and thereby a validation of the information produced. The project is also known as the Jiskefet project.

This is the front-end UI for the Jiskefet project.
The back-end API can be found here: https://github.com/SoftwareForScience/jiskefet-api
And the Ansible playbook to deploy the application can be found here: https://github.com/SoftwareForScience/sfs-ansible

Table of Contents

Running the app for dev

$ npm install

# Copy .env.dist as .env and set your own values.
$ cp .env .env.dist

# Running in watch mode (webpack-dev-server)
$ npm run dev

Then go to http://localhost:8080/ in your browser.

Running the app for prod

$ npm install

# Copy .env.dist as .env and set your own values.
$ cp .env .env.dist

# The bundle is located at `dist/app.bundle.js`
$ npm run build

The bundle can then be served via a webserver, e.g. nginx.

Documentation

The following section explains the stack of the project and links to docs.

Mithril (SPA Framework)

We use Mithril as a SPA framework.

Sass/SCSS (Styling)

We use SCSS as an extension to vanilla css.

Bootstrap

Bootstrap is used as a style/component library.

Redux (State management)