Changes for page Running KEITH

Last modified by Richard Kreissig on 2023/09/14 08:48
<
From version < 33.1 >
edited by Niklas Rentz
on 2019/09/12 13:19
To version < 36.1 >
edited by Soeren Domroes
on 2020/04/16 11:49
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.nre
1 +XWiki.sdo
Content
... ... @@ -8,17 +8,20 @@
8 8  
9 9  For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
10 10  
11 -Use the installer go to advanced mode, add the KIELER url. Then select first semantics and after that pragmatics (**that is very** **important**). You can see that you have done that correctly on the automatically generated name of your Eclipse: It should be something like kieler-semantics-theia.
11 +Use the installer go to advanced mode, add the KIELER url. If you plan to develop for the semantic language server (e.g. for the compiler) you should select KIELER semantics for diagram only KIELER pragmatics. In any case select the keith stream.
12 12  
13 -Select the Theia stream for semantics and the Keith stream for pragmatics and use the latest Eclipse if possible. Set the targetplatform to latest and finish.
13 +If you plan to develop in elk at the same time first select the Eclispe Layout Kernel setup and after that the semantics or pragmatics setup.
14 14  
15 15  Wait till everything installs and the setup tasks finish. If you have any problems in this stage refer to the [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
16 16  
17 -\\
17 +If you have problems in the workspace that are still there after a clean build do the following:
18 18  
19 -The setup tasks for Modular Target will fail. Disable it after this happens and execute them again via //Help>Perform Setup Tasks//. Open the //plug-in development// perspective. Select working sets as top level elements. Run //clean build//. Several pragmatics projects have errors. Just close them and you will be fine.
19 +* Disable Project>Build automatically
20 +* Select all Klighd and pragmatics plugins and do Project>Clean>Only selected and build only selected
21 +* Do the same for the semantics projects
22 +* Enable Project>Build automatically
20 20  
21 -To run the language server go to //Run Configurations// create a new E//clipse Application// run configuration and select //Run an application//  and //de.cau.cs.kieler.language.server.LanguageServer//
24 +To run the language server go to //Run Configurations// create a new E//clipse Application// run configuration and select //Run an application//  and //de.cau.cs.kieler.language.server.LanguageServer// (for semantics LS,//de.cau.cs.kieler.kgraph.language.server.LanguageServer// otherwise)
22 22  
23 23  == [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
24 24  
... ... @@ -38,7 +38,7 @@
38 38  
39 39  [[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
40 40  
41 -The default port to which KEITH tries to connect is 5007.
44 +The default port to which KEITH tries to connect is 5007. You can of course change this for the languae server but be aware that this has to be changed in KEITH too.
42 42  
43 43  == Setting up a KEITH developer setup... ==
44 44  
... ... @@ -115,8 +115,44 @@
115 115  
116 116  = Stuff that may help =
117 117  
118 -== Running the already build LS ==
121 +== How to run KEITH in developer setup (socket) ==
119 119  
123 +Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
124 +
125 +=== Running KEITH in the browser ===
126 +
127 +\\
128 +
129 +{{code language="bash"}}
130 +yarn && cd keith-app && yarn run socket
131 +{{/code}}
132 +
133 +//yarn// builds all the stuff. //yarn run socket// in keith-app starts the application. After an initial build via yarn you can run //yarn watch //to watch the changes in your repository. In another console you run yarn run socket in keith-app. Now refreshing your browser is enough to apply the changes.
134 +
135 +Per default the KEITH opens on localhost:3000.
136 +
137 +{{info}}
138 +If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
139 +{{/info}}
140 +
141 +Run Launch in Chrome via VSCode to open a chrome browser on localhost:3000
142 +
143 +This is necessary to be able to debug in VSCode.
144 +
145 +=== Running KEITH as (unbundled) electron app ===
146 +
147 +{{code language="bash"}}
148 +yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
149 +{{/code}}
150 +
151 +//yarn// builds all the stuff. //yarn run socket// in keith-app-electron starts the application. After an initial build via yarn you can run //yarn watch //to watch the changes in your repository. In another console you run yarn run socket in keith-app-electron. Now refreshing your browser is enough to apply the changes.
152 +
153 +{{info}}
154 +If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
155 +{{/info}}
156 +
157 +== Running the already build LS (you normally do not want to do this) ==
158 +
120 120  Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
121 121  
122 122  [[image:attach:image2019-2-7_17-46-58.png]]
... ... @@ -164,40 +164,8 @@
164 164  
165 165  The {{code language="none"}}LSP_PORT{{/code}} option is used to activate the connection via socket. It is also possible to specify a relative location to a LS via {{code language="none"}}LS_PATH=<path to LS>{{/code}}.
166 166  
167 -== How run KEITH in developer setup (socket) ==
206 += Known Issues =
168 168  
169 -Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
170 -
171 -=== Running KEITH in the browser ===
172 -
173 -\\
174 -
175 -{{code language="bash"}}
176 -yarn && cd keith-app && yarn run socket
177 -{{/code}}
178 -
179 -//yarn// builds all the stuff. //yarn run socket// in keith-app starts the application. After an initial build via yarn you can run //yarn watch // to watch the changes in your repository. In another console you run yarn run socket in keith-app. Now refreshing your browser is enough to apply the changes.
180 -
181 -Per default the KEITH opens on localhost:3000.
182 -
183 -{{info}}
184 -If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
185 -{{/info}}
186 -
187 -\\
188 -
189 -=== Running KEITH as (unbundled) electron app ===
190 -
191 -{{code language="bash"}}
192 -yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
193 -{{/code}}
194 -
195 -//yarn// builds all the stuff. //yarn run socket// in keith-app-electron starts the application. After an initial build via yarn you can run //yarn watch // to watch the changes in your repository. In another console you run yarn run socket in keith-app-electron. Now refreshing your browser is enough to apply the changes.
196 -
197 -{{info}}
198 -If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
199 -{{/info}}
200 -
201 201  === Known issues for windows: ===
202 202  
203 203  nsfw.code not found: In the top level package.json exists a script called postinstall. Remove this on windows, delete the node_modules folder and rebuilt the application. This is a known issue of electron-builder.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -73072681
1 +75694098
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/73072681/Running KEITH
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/75694098/Running KEITH

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage