Findings in current build process
Hello there,
While testing the new GUI, I encountered a few issues and found a few improvement ideas. I will use this issue to forward them to you.
Wrong import
I ran into an error in frontend class NavTabs
, that the import statement import { StepperLine, StyledStepLabel, TabStyled } from "./navTabs.styles";
failed because component StepperLine
and StyledStepLabel
were not found in class ./navTabs.styles
. I had to import these two components from ./navTabs.styles.tsx
(with ending .tsx) in order to make it work.
Improvements
- The configuration of
backend/backendConfig.json
is a bit hidden when not building the docs. When starting to use this project, I only followed the README.md (as it seemed to contain the all the required steps). As this may happen to other users as well, I suggest to either move the description on how to configure the backendConig to the README.md or tell users in the README.md to build the documentation. - The Backend uses multiple logging libraries, e.g.
logging:Debug
vsqDebug
. - The Backend verifies some paths but not all (e.g. whether the expected path for the frontend exists).
- This repository has to be located at a specific path on the file system (in the home directory). It would be convenient if there isn't this hard requirement of putting the repo in the HOME directory. A possible solution would be define a new variable that the user can overwrite:
- In the backend, this variable then can replace the usages of
BackendConfig::PATH_HOME
. - Read this variable in
package.json
andinstallation/install-<OS>.<file-ending>
and have$HOME
as a fallback if it is not defined. - Define another variable for the opSimulation core and read it the
deb-launch
command inpackage.json
.
- Adding a .gitignore file with following entries will make it easier to keep track of changes (as e.g. all new node modules are filtered):
node_modules
frontend/..backendbuild
frontend/dist
**/yarn.lock
.vscode
backend/build
Paul Romahn (paul.romahn@mercedes-benz.com) on behalf of Mercedes-Benz Tech Innovation GmbH.
Edited by Paul Romahn