From 8cf2b6a7b06d71354883c8b2fc2b3a2071929182 Mon Sep 17 00:00:00 2001 From: chrisjstevo Date: Mon, 14 Nov 2022 13:13:11 +0100 Subject: [PATCH] #302 Cleanup of dependencies and so docco post Finos move. (#313) --- README.md | 9 ++- docs/getting_started/developing.md | 66 ++++++++++++------ docs/team.mdx | 8 ++- pom.xml | 44 +++++++++++- toolbox/pom.xml | 67 ------------------- .../array/NiaveImmutableArray.scala | 17 ++--- vuu-ui/package.json | 3 + vuu/pom.xml | 15 +++++ .../runconfigurations/SimulMain.run.xml | 2 +- website/docusaurus.config.js | 4 +- 10 files changed, 130 insertions(+), 105 deletions(-) diff --git a/README.md b/README.md index b241ddf97..aa0100210 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,14 @@ this should be the same as Linux & macos just with windows adjusted paths ``` ## Installation - Client + +Please note, while we are in the process of making the ag-grid dependencies optional you will +need to run this command from the vuu/vuu-ui directory. + +```sh +yarn add -W ag-grid-community ag-grid-enterprise ag-grid-react +``` +Then this: ```sh #in vuu repo (not vuu child directory in repo) cd vuu-ui @@ -46,7 +54,6 @@ cd packages/electron yarn start ``` - ## Usage example ``` diff --git a/docs/getting_started/developing.md b/docs/getting_started/developing.md index b7d69818d..21b088d91 100644 --- a/docs/getting_started/developing.md +++ b/docs/getting_started/developing.md @@ -1,6 +1,6 @@ # Developing Vuu -## Developing the server +## Prerequisites 1) Install IntelliJ Community Edition (latest version, tested with 2021.3) 2) Install SDKMan from the [website](https://sdkman.io/) or using your own mechanism @@ -10,11 +10,6 @@ 6) You should get one root module vuu-parent in a project list, select this 7) When the project opens you should have 2 sub-modules (vuu and toolbox) -## Running the Vuu Server Simulation Module - -1) Go to the SimulMain.scala, right click and run (add these into JVM args -Xmx10G -Xms5G) -2) Go to the SwingClientMain.scala, right click and run - ## Developing the client If you are comfortable running the server in an IDE, you can follow the instructions above. If not @@ -25,25 +20,58 @@ You can install command line maven via any means you please, but sdkman makes it sdk install maven ``` -```bash -#after checking out the code, in project root dir -mvn clean compile -#then into the vuu subfolder +## Installation - Server - Command Line + +### Prerequisites + +See the [Docs](https://vuu.finos.org/docs/getting_started/developing) for Java versions and install dependencies you need to have. + +OS X & Linux: + +```sh +#In your favourite code directory... +git clone https://github.com/finos/vuu.git +#cd into the repository +cd vuu +#run the maven compile step +mvn compile +#cd into vuu, child in repo cd vuu -#run SimulMain using maven exec:exec plugin +#The server should now be started on your machine with Simulation module mvn exec:exec ``` +Windows: +```sh +this should be the same as Linux & MacOS just with Windows adjusted paths +``` + +## Running the Vuu Server Simulation Module from IDE + +1) Go to the SimulMain.scala, right click and run (add these into JVM args -Xmx10G -Xms5G) +2) Go to the SwingClientMain.scala, right click and run -1) install node.js version 14+ and yarn -2) In a terminal, change directory into the ./vuu-ui folder -3) yarn install -4) type> ```yarn``` -5) build the ui library packages -6) type> ```yarn build``` -7) build the sample application -8) type> ```yarn build:app``` +## Installation - Client + +Please note, while we are in the process of making the ag-grid dependencies optional you will +need to run this command from the vuu/vuu-ui directory. + +```sh +#Please note these are licenced software components, they will be made optional shortly in Vuu +yarn add -W ag-grid-community ag-grid-enterprise ag-grid-react +``` +Then this: +```sh +#in vuu repo (not vuu child directory in repo) +cd vuu-ui +yarn +yarn build +yarn buid:app +cd packages/electron +#this should open an electron window pointing at https://localhost:8443/index.html +yarn start +``` You should know be able to use a local browser to see the Vuu demo app. [localhost:8443](https://localhost:8443/index.html) diff --git a/docs/team.mdx b/docs/team.mdx index 2ffb114db..afae3196b 100644 --- a/docs/team.mdx +++ b/docs/team.mdx @@ -5,6 +5,8 @@ title: {project name} Team --- This is the {project name} team: -1. bla -2. bla -3. bla +1. Chris Stevenson, UBS, Lead Contributor +2. Steve Heron, UBS, Lead Contributor +3. Allan Jakobsen, UBS, Product Owner +4. Michael Banham, UBS, Contributor +5. Marina Bambang, UBS, Product Owner \ No newline at end of file diff --git a/pom.xml b/pom.xml index ea0e6410f..e237107d6 100644 --- a/pom.xml +++ b/pom.xml @@ -66,8 +66,8 @@ 4.2.5 3.1.0 3.2.9 - 3.9.4 - 2.14.0-rc3 + 3.9.5 + 2.14.0 1.17.0 4.11.1 4.1.82.Final @@ -115,6 +115,46 @@ + + ch.qos.logback + logback-classic + ${logback.version} + + + + ch.qos.logback + logback-core + ${logback.version} + + + + com.typesafe.scala-logging + scala-logging_2.13 + ${scala.logging} + + + org.scala-lang + scala-library + + + org.scala-lang + scala-reflect + + + + + + org.slf4j + log4j-over-slf4j + 1.7.32 + + + + org.slf4j + slf4j-api + 1.7.32 + + org.scalatest scalatest_2.13 diff --git a/toolbox/pom.xml b/toolbox/pom.xml index b5c855ce2..30e5c8c78 100644 --- a/toolbox/pom.xml +++ b/toolbox/pom.xml @@ -26,7 +26,6 @@ test - io.dropwizard.metrics metrics-core @@ -45,72 +44,6 @@ 2.10.13 - - - - - - - - ch.qos.logback - logback-classic - ${logback.version} - - - - ch.qos.logback - logback-core - ${logback.version} - - - - com.typesafe.scala-logging - scala-logging_2.13 - ${scala.logging} - - - org.scala-lang - scala-library - - - - - - org.slf4j - log4j-over-slf4j - 1.7.32 - - - - org.slf4j - slf4j-api - 1.7.32 - - - - org.antlr - antlr4 - ${antlr.version} - - diff --git a/toolbox/src/main/scala/org/finos/toolbox/collection/array/NiaveImmutableArray.scala b/toolbox/src/main/scala/org/finos/toolbox/collection/array/NiaveImmutableArray.scala index 7ef1ee2e3..5a0e1ab71 100644 --- a/toolbox/src/main/scala/org/finos/toolbox/collection/array/NiaveImmutableArray.scala +++ b/toolbox/src/main/scala/org/finos/toolbox/collection/array/NiaveImmutableArray.scala @@ -20,16 +20,13 @@ class NiaiveImmutableArray[T :ClassTag](val array: Array[T] = Array.empty) exten } override def equals(obj: scala.Any): Boolean = { - if(obj.isInstanceOf[NiaiveImmutableArray[T]]){ - - val toCheck = obj.asInstanceOf[NiaiveImmutableArray[T]].array - - val isEq = toCheck == array - - isEq - - } else{ - false + obj match { + case value: NiaiveImmutableArray[_] => + val toCheck = value.array + val isEq = toCheck == array + isEq + case _ => + false } } diff --git a/vuu-ui/package.json b/vuu-ui/package.json index 10ea4be43..e91062eb0 100644 --- a/vuu-ui/package.json +++ b/vuu-ui/package.json @@ -35,6 +35,9 @@ "@types/react": "^17.0.2", "@types/react-dom": "^17.0.2", "@typescript-eslint/parser": "^5.41.0", + "ag-grid-community": "^28.2.1", + "ag-grid-enterprise": "^28.2.1", + "ag-grid-react": "^28.2.1", "classnames": "^2.3.1", "react": "^17.0.2", "react-dom": "^17.0.2", diff --git a/vuu/pom.xml b/vuu/pom.xml index cd75b1afa..9cadde5da 100644 --- a/vuu/pom.xml +++ b/vuu/pom.xml @@ -42,6 +42,11 @@ ${scala.version} + + org.scala-lang + scala-reflect + ${scala.version} + junit @@ -55,6 +60,16 @@ scalatest_2.13 ${scalatest.version} test + + + org.scala-lang + scala-library + + + org.scala-lang + scala-reflect + + diff --git a/vuu/src/main/resources/runconfigurations/SimulMain.run.xml b/vuu/src/main/resources/runconfigurations/SimulMain.run.xml index e3fd378c2..a83280305 100644 --- a/vuu/src/main/resources/runconfigurations/SimulMain.run.xml +++ b/vuu/src/main/resources/runconfigurations/SimulMain.run.xml @@ -2,7 +2,7 @@