Setup a Development Workspace

Please follow the workspace setup if you want to develop and contribute to LineUp.js.

Prerequisites

Install Node.js, Yeoman and the Phovea Generator.

Installation

1. Create an empty workspace directory: mkdir lineup_workspace && cd lineup_workspace
2. Clone repositories
3. Clone LineUp repository: git clone -b release_1.x https://github.com/Caleydo/lineup.js.git (Note: make sure to check out LineUp >= 1.x)
4. Clone the demo page: git clone https://github.com/sgratzl/lineup_demos_source.git
5. (Optional) If you want to modify check other plugins (e.g, phovea_importer) clone them, too: git clone https://github.com/phovea/phovea_importer.git
6. Create workspace: yo phovea:workspace with the following inputs:

• Virtual Environment: none
• Additional Plugins: none (just press Enter)

6. Install dependencies: npm install
7. Creating a symbolic link for the LineUp library
8. Remove directory node_modules/lineupjs and ...
9. Create symbolic link instead * On Windows: mklink /J "node_modules/lineupjs" "lineup.js" * On Linux/Mac: ln –s "lineup.js" "node_modules/lineupjs"

Run Workspace

1. Open command line in your workspace directory
2. Run npm run start:lineup_demos_source
3. Open web browser with the URL (e.g. localhost:8080) printed in the console output