08191991d08ce0d8c3313258c2a9fce0f20b678e
SEAWeb
The WEB GUI client of SEA.
This repository contains the code of the server for the control and graphical parts, plus the client code (HTML, CSS, JS)
Documentation
./doc/
blocks.tsv <-- (DE) Indicates the position of the different blocks depending on the screen size
client.md <-- (ENG) Developper documentation about the client part
message_chain.txt <-- (ENG) Gives the message chain (API calls) for builiding the different blocks
protocol.txt <-- (ENG) Gives a summary of the different server response payloads
server.md <-- (ENG) Developper documentation about the server part
variables_config.md <-- (ENG) User/programmer documentation about configuring parameters for the graphical part
Procedures
Installation (!!! WIP !!!)
- Clone this repository on the
~folder on your machine - If not done yet, activate a Python environnment
- Run the command
cd seaweb
Configuring the application (!!! WIP !!!)
Starting the application (!!! WIP !!!)
- Run the command
cd ~/seaweb
Stopping the application
- Run the command
ps ax | grep seaweb - In the output of the previous command, identifiy the PID corresponding to the server process
- Run the command
kill <previously_identified_PID>
Possible improvements to bring
- When the livemode is activated on the server, the data of all available variables is sent, even if some of them are not displayed on the client
- The components made on the client use class instead of ids to identify the elements that are in their own context. To have a more lightweight code, and prevent side effects, it would be a good way to see if HTML shadow root could be used to isolate elements.
Description
Languages
JavaScript
71.4%
Python
14.1%
CSS
10.2%
HTML
4.3%