minnojs / minno-dashboard

Client-side of minno’s study management and authoring tool
1 stars 2 forks source link

PI Dashboard

This is the repository for the PI dashboard.

Installation

In order to test it out you should first clone it:

git clone https://github.com/ProjectImplicit/pi-validator.git

Next you should install all dependencies:

npm install

You should see all dependencies being downloaded from npm and bower.

Development

This project is written in es6 (using babel and rollup). CSS is generated using SASS. Source files are built from the src directory to dist. All build tasks are managed npm scripts.

Running npm start will set up a development server with mocks for all backend operations (see fixtures.js) as well as watch src for changes and rebuild the project for every change.

Structure

We use mithril.js as our framework of choice, and polyfills to make sure Promise and Fetch work everywhere.

The routes are set up in /src/routes.js and wrapped within the layout component at /layoutComponent.js, The layout component is also responsible for user authentication. Each of the main routes of the dashboard has a directory of its own, and there is a directory for commonly used utilities as well.