Skip to content

User Guide to SP

Jump to bottom
Alexander Åstrand edited this page Jun 27, 2018 · 1 revision

User Guide to SP

First of you need these tools to begin use SP, and you need to start use the terminal on your computer. But hey, do not be afraid if you are new to these tools, we will try to help you out!

  • Simple Build Tool (SBT)
  • Terminal (Command Prompt on Windows, Bash or other shells)
  • Github
  • Node.js

Simple Build Tool Visit their website and go to the Download-page. Right now, SP is using sbt 0.13.15. Download and install to your computer. Go to sbt:s documentation for how to install on your computer.

Terminal On most computers you don’t need to download any external software.

Github Create a github-account and set up git.

Node.js Go to nodejs.org/download and download for your computer.

Web Browser Chrome, Opera, Firefox or whatever you prefer.

Installation

  1. Fork
  2. Clone
  3. Install Javascript dependencies
  4. Open sbt
  5. Compile the project
  6. Generate Javascript-code
  7. Open the project

Fork

Fork a repo from sp-org, let’s go ahead and fork sp-gui.

Go to https://github.com/sequenceplanner/sp-gui/ and in the top-right corner press Fork, and fork to your user (https://github.com//)

Clone

Clone your fork from github by open your terminal and go to a place where you can clone your project into. If this is your first time cloning github repos, make a new folder.

This User Guide was done on a Windows 10 operative system, but is convertable to others too.

C:\Users\User1>mkdir github
C:\Users\User1>cd github
C:\Users\User1\github>git clone https://github.com/<username>/sp-gui
C:\Users\User1\github>cd sp-gui

Install Javascript dependencies

C:\Users\User1\github\sp-gui>cd npmdependencies 
C:\Users\User1\github\sp-gui\npmdependencies>npm install

Open sbt

C:\Users\User1\github\sp-gui\npmdependencies>cd ..
C:\Users\User1\github\sp-gui>sbt

Now sbt is loading, downloading and updating the project + plugins

Compile

To compile the full project, type >compile

Generate Javascript-code

One time,
>spguiJS/fastOptJS

For continuous updating,
>~spguiJS/fastOptJS

NOTE: If java.util.concurrent.ExecutionException: java.lang.OutOfMemoryError: GC overhead limit exceeded…, set JAVA_OPTS in Environment Variables to “-Xms512m -Xmx4G” export JAVA_OPTS=“-Xms512m -Xmx4G” or setx /m JAVA_OPTS “-Xms512m -Xmx4G” depending on operative system.

Open the project

In sbt, use continuous updating and in your web browser type http://localhost:12345/js/target/scala-2.12/classes/index.html

Clone this wiki locally