Frontend Tips

This page contains tips and additionnal information that could be useful in using and developing for the project.

General

1. The teams is using VS Code to program the frontend.
2. Using ESLint with VS Code needs a change in configs.
3. As said previously, in dev mode the code rebuild the code on file save, so you don't need to manually rebuild every time to see the change on the web page. You might want to refresh the page from time to time since we have observed that it might not the page on rebuild.
4. If something seems to not work correctly or is missing, update the packages you might be missing one.

Components

1. Components talk with each other using event bus. Look at the code documentation to see the events used.
2. Most of the html part only uses Bootstrap classes for their CSS. It should be kept that way as much as possible.
3. The easyrtc api is globally available but only used in the layout component so the connection stay when navigating between pages.
4. We are trying to make everything fit in the different pages without the use of scrolling.

Development

1. There is 2 pages named testing. Those pages can allow someone to test the easyrtc and general behaviour of the program without having a robot to test with.
2. If you want to simulate video feed, we recommend v4l2loopback with Gstreamer.
3. To test using easyrtc, you can create and host a server locally or somewhere else and point the easyrtc api to that server. That's what we are doing, our easyrtc server do not serve the web interface, the interface is serve locally and we link it to the server.