From 975a87d84c55480ae58d756d226a9face1f3e79f Mon Sep 17 00:00:00 2001 From: juanf <juan.fuentes@id.ethz.ch> Date: Mon, 27 Jun 2022 14:48:19 +0000 Subject: [PATCH] Update README.md --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 50532887d1a..e477b53fb2c 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ config.bundle.min.js openbis.bundle.js openbis.bundle.min.js -# Developing openBIS +# Development of openBIS ## Requirements - Postgres 11 @@ -60,11 +60,24 @@ openBISDevelopementEnvironmentDSSStart ## IntelliJ can't find package com.sun.*, but I can compile the project using the command line! Turn off "File | Settings | Build, Execution, Deployment | Compiler | Java Compiler | Use --release option for cross-compilation". -# Developing openBIS NG UI -- From the command line on the root folder of this repo: -cd openbis_ng_ui -npm install -npm run dev +## Development of NG UI -- Open the path indicated on the command Line on the browser: http://0.0.0.0:8124/ng-ui-path/ -- The development mode of the openBIS NG UI requires to have openbis running +1. Generate openBIS JS bundle by running in command line + 1. cd /<OPENBIS_PROJECT_ROOT>/openbis_standard_technologies + 2. ./gradlew :bundleOpenbisStaticResources +2. Start openBIS in your chosen IDE (NG UI assumes it will run at: http://localhost:8888/openbis-test/): + 1. run openBISDevelopementEnvironmentASPrepare gradle task + 2. run openBISDevelopementEnvironmentASStart gradle task +3. In command line do: + 1. cd /<OPENBIS_PROJECT_ROOT>/openbis_ng_ui + 2. npm install + 3. npm run dev +4. Open in your chosen browser a url, by default: http://localhost:8124/ng-ui-path + +## Setting up IntelliJ Idea + +1. Under "IntelliJ IDEA" -> "Preferences" -> "Languages and Frameworks" -> Javascript, set the language version to ECMAScript 6. + +## Setting up Visual Studio Code (alternative to IntelliJ Idea) + +Install "ESLint" and "Prettier - Code formatter" extensions. -- GitLab