Home

Welcome to the CyberSim-UI wiki!

Here you can find basic information on the source code of this project.

Main backend communication and application logic related dependencies you should look into before jumping into the project:

• react
• axios for REST api
• @risingstack/react-easy-state for complex React stores
• socket.io for WebSocket communication

Main style and design related dependencies:

• bootstrap for styling
• react-bootstrap for Bootstrap based React Components
• sass for styling

There are two main data providers:

• StaticDataProvider.jsx for static data provided by the backend REST API. This is a React Context with a custom hook to "use" the data.
• GameStore.jsx global react-easy-state store for dynamic game-related data and functions. This file is responsible for socket.io communication, it emits game-state changing events and listens for updates.