@finos/legend-application-repl-deployment 11.42.0 → 11.44.0

Sign up to get free protection for your applications and to get access to all the features.
package/README.md CHANGED
@@ -1,3 +1,37 @@
1
1
  # @finos/legend-application-repl-deployment
2
2
 
3
3
  This is the `Legend REPL` web application deployment. This is used for development locally
4
+
5
+ ## Backend
6
+
7
+ `Legend REPL` relies on:
8
+
9
+ - [Legend Engine](https://github.com/finos/legend-engine) [REPL Client](https://github.com/finos/legend-engine/blob/master/legend-engine-config/legend-engine-repl/legend-engine-repl-relational/src/main/java/org/finos/legend/engine/repl/relational/client/RClient.java).
10
+
11
+ ## Getting started
12
+
13
+ To quickly setup the backend, spin up `REPL Client` application:
14
+
15
+ - In order to start the server, please use the `Main` class `org.finos.legend.engine.repl.relational.client.RClient`
16
+ - This will open a new terminal in your IDE with REPL Client up and running. This will also print the port at which backend server for grid is running at.
17
+ - If you wish to change the port for backend server (preferably 8080 as client assumes server runs at this port) please modify port here [REPL Grid Server](https://github.com/finos/legend-engine/blob/master/legend-engine-config/legend-engine-repl/legend-engine-repl-relational/src/main/java/org/finos/legend/engine/repl/relational/httpServer/ReplGridServer.java)
18
+
19
+ Before spinning up the application make sure to run these commands on `REPL terminal` so that there is an initial query state for grid.
20
+
21
+ ```bash
22
+ load <path> <connection>
23
+ #>{<db.table>}#->from(<connection>)
24
+ show
25
+ ```
26
+
27
+ To know about more specific synatx of these commands type `help` on the REPL terminal.
28
+
29
+ Last but not least, make sure you have `Yarn` installed. Run the following commands in order.
30
+
31
+ ```bash
32
+ yarn install
33
+ yarn setup
34
+ yarn dev:repl
35
+ ```
36
+
37
+ After setting up, visit http://localhost:9005/repl/grid and the application should be up and running.
@@ -1 +1 @@
1
- <!doctype html><html lang="en"><head><title>REPL</title><meta charset="UTF-8"/><meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"/><link rel="icon" href="/repl/favicon.ico"><script defer="defer" src="/repl/static/vendor.189c9288.js"></script><script defer="defer" src="/repl/static/index.c7cbdec8.js"></script><link href="/repl/static/vendor.3989ede3.css" rel="stylesheet"><link href="/repl/static/index.b2c74cd4.css" rel="stylesheet"></head><body style="width: 100%; height: 100vh; overflow: hidden"></body></html>
1
+ <!doctype html><html lang="en"><head><title>REPL</title><meta charset="UTF-8"/><meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"/><link rel="icon" href="/repl/favicon.ico"><script defer="defer" src="/repl/static/vendor.189c9288.js"></script><script defer="defer" src="/repl/static/index.237168cd.js"></script><link href="/repl/static/vendor.3989ede3.css" rel="stylesheet"><link href="/repl/static/index.e4523ca6.css" rel="stylesheet"></head><body style="width: 100%; height: 100vh; overflow: hidden"></body></html>