Lab-08 ARSW

This programm allow multiple users to draw in a board using realtime 2024/07/09

Architecture

As seen by this diagram we can see the run time in which each user connects via browser to the host using http and the 8080 port, and this browser will be supported by a React mounted client that works with ReactDOM that creates a Root that renders the editor, this editor supports the canvas that each user will be using, this canvas contains a svrStatus object that contains the connection status with the server, a comunicationWS object that works with the React.Ref library and the myp5 object that mantains the canvas.

the BBCanvas uses the WSBBChannel which purpose is to mantain connections and send data to the server, this uses the BBServiceURL to initialize the URL given X host, then communicates to the server via WebSockets and references either /bbService or /status paths, the interactiveblackboardApplication validates each path given and returns the corresponding result with each point given and broadcast all points that are getting sent to the server.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

First you need the following java version (command to see your current java version below)

java -version

to see the maven version we are using we need to enter the following command, also this is the version of Maven this programm uses

mvn -version

Installing

First clone this proyect into your own system, then

mvn clean package

Acceptance test

This test is run in a deployed service on EC2 as seen in the image

As seen here the program works succesfully on an EC2 instance painting everything the two users ask.

Generating javadoc

Simply enter the following commands

mvn javadoc:javadoc

mvn javadoc:jar

mvn javadoc:aggregate

mvn javadoc:aggregate-jar

mvn javadoc:test-javadoc 

Deployment

IN ORDER FOR THIS PROGRAM TO WORK, YOU'LL NEED TO EXECUTE THE PROGRAM ON THE FOLDER YOU WANT TO WORK WITH, WITH THE FILES YOU WANT TO WORK WITH

if you want to use the programm after using the package command we use

mvn spring-boot:run

after the server has initialized, you'll have to type in the browser

http://localhost:8080

Built With

• Maven - Dependency Management
• Java - Programming Language
• HTML 5 - HiperText Markup Lenguaje
• Spring - Framework
• React- Front-end Libray

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Santiago Parra - Initial work - Parralol