aggipp/hyplag-frontend-assets repository overview

⁠HyPlag Frontend-Assets

FE part for the new Rails based implementation

⁠Prerequisites

The app uses Node Package Manager⁠ and grunt⁠.

• install node / npm ()>= version 7.x) see https://nodejs.org/en/download/package-manager/⁠

example

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs

To install grunt after you have set up npm you can run npm install -g grunt-cli

For documentation you need to install JSdoc npm i jsdoc

To install the latest version on npm globally (might require sudo) npm install -g jsdoc

To install the latest version on npm locally and save it in your package's package.json file: npm install --save-dev jsdoc

⁠Setup

⁠Package installation

In the root folder run npm install to install all dependencies.

⁠Compiling

Run grunt to compile the pug templates and scss

⁠Development

⁠File-Watcher

During development run grunt to automatically recompile after a .pug or .scss file have been saved.

⁠Linting

An ESLinter has been set up. If you use atom you might want to install the linter and linter-eslint plugins.

⁠Deployment

$ cap production deploy

⁠Documentation

$ npm run docs

⁠FAQ and Problems

On Ubuntu 16: /usr/bin/env: ‘node’: No such file or directory

sudo apt-get install nodejs-legacy, since many libs on debian will call nodejs instead of node

'grunt build' problem: "You need to have Ruby and Sass installed and in your PATH for this task to work."

probably a fsevents problem, see https://github.com/gruntjs/grunt-contrib-sass⁠ and run sudo gem install sass yourself.

⁠Docker

To setup a development/testing environment using docker you need to install docker-compose on your system. Currently, you need to setup maven 8 and java 8 in addition. To run docker follow the following steps:

1. Checkout all submodules git submodule update --init --recursive
2. Build the backend jar file. Navigate to hyplag-backend⁠ and run mvn clean package -DskipTests
3. Start docker by running docker-compose up

Now you can navigate to the frontend⁠, backend⁠ and frontend assets⁠.

The passwords are stored in your .env file.