Changes for page Running KEITH

Last modified by Richard Kreissig on 2023/09/14 08:48
<
From version < 34.1 >
edited by Soeren Domroes
on 2020/03/27 14:35
To version < 37.1 >
edited by Soeren Domroes
on 2020/05/14 13:42
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -10,10 +10,19 @@
10 10  
11 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 -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.
13 +If you plan to develop in elk at the same time first select the Eclispe Layout Kernel setup and after that either 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 +Make sure that you have necessary forks of ELK/KlighD set up.
18 +
19 +If you have problems in the workspace that are still there after a clean build do the following:
20 +
21 +* Disable Project>Build automatically
22 +* Select all Klighd and pragmatics plugins and do Project>Clean>Only selected and build only selected
23 +* Do the same for the semantics projects
24 +* Enable Project>Build automatically
25 +
17 17  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)
18 18  
19 19  == [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
... ... @@ -111,8 +111,44 @@
111 111  
112 112  = Stuff that may help =
113 113  
114 -== Running the already build LS ==
123 +== How to run KEITH in developer setup (socket) ==
115 115  
125 +Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
126 +
127 +=== Running KEITH in the browser ===
128 +
129 +\\
130 +
131 +{{code language="bash"}}
132 +yarn && cd keith-app && yarn run socket
133 +{{/code}}
134 +
135 +//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.
136 +
137 +Per default the KEITH opens on localhost:3000.
138 +
139 +{{info}}
140 +If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
141 +{{/info}}
142 +
143 +Run Launch in Chrome via VSCode to open a chrome browser on localhost:3000
144 +
145 +This is necessary to be able to debug in VSCode.
146 +
147 +=== Running KEITH as (unbundled) electron app ===
148 +
149 +{{code language="bash"}}
150 +yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
151 +{{/code}}
152 +
153 +//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.
154 +
155 +{{info}}
156 +If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
157 +{{/info}}
158 +
159 +== Running the already build LS (you normally do not want to do this) ==
160 +
116 116  Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
117 117  
118 118  [[image:attach:image2019-2-7_17-46-58.png]]
... ... @@ -160,40 +160,8 @@
160 160  
161 161  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}}.
162 162  
163 -== How run KEITH in developer setup (socket) ==
208 += Known Issues =
164 164  
165 -Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
166 -
167 -=== Running KEITH in the browser ===
168 -
169 -\\
170 -
171 -{{code language="bash"}}
172 -yarn && cd keith-app && yarn run socket
173 -{{/code}}
174 -
175 -//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.
176 -
177 -Per default the KEITH opens on localhost:3000.
178 -
179 -{{info}}
180 -If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
181 -{{/info}}
182 -
183 -\\
184 -
185 -=== Running KEITH as (unbundled) electron app ===
186 -
187 -{{code language="bash"}}
188 -yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
189 -{{/code}}
190 -
191 -//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.
192 -
193 -{{info}}
194 -If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
195 -{{/info}}
196 -
197 197  === Known issues for windows: ===
198 198  
199 199  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 -73072823
1 +75694100
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/73072823/Running KEITH
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/75694100/Running KEITH