Detailed Design Report

[vedxyz]

Details about the new report can be gathered under this issue.

Looks like the report is a mix of making UML diagrams and documenting the technologies that will be used.

[vedxyz]

Below is a draft/possible list of technologies to be used.

Back-end

• Spring (REST API)

  • Spring Security
  • Spring MVC

  REST API, located at /api/, exposes all data any user may need but only with proper authentication. Client makes requests with sessionid cookie embedded, Redis storage is looked up for authentication, data endpoints are authorized accordingly with user account permission level. Spring controller "forwards" all non-API requests to SPA root, where ReactJS acts as the Router.

• MongoDB Persistent storage; account data, etc.

• Redis Short-term storage; user session, etc.

Front-end

• SASS (CSS)
• ReactJS (SPA model) Single page application rendered client-side, client makes requests to /api/ in the background, ReactJS serves components according to data received.

Build & Utility tools

• Spring Boot
• Maven / Gradle (Could Maven be better?)
• Docker Use docker-compose to deploy separate DB/App containers?

Domain & Host

• labconnect.me domain (labconnect.xyz alternatively?) (Claim offer from GH Education Pack, or purchase at namecheap.com)
• VPS to run the DB/App containers? DigitalOcean?

[berkan-sahin]

Some clarification on the objectives/requirements of this report (taken from the course webpage)

• [x] Introduction: a one or two sentence reminder of what your project is.
• [x] System Overview: a diagram showing the basic organization/architecture and a few explanatory sentences saying what form your application will take (desktop, mobile, web, server, ...) as well as an idea of the technologies you will employ (Swing, JavaFX, Android, JSON, XML, HMTL, Servlets, JSP, Serialization, databases, etc.).
• [x] Core Design Details: a UML class (and/or object) diagram, together with a few notes to help readers understand the contents of the diagram. Note: Do not include GUI (View / Controller) classes, only the core Model classes [of] your application are needed. [emphasis added]
• [x] Task assignment: a list saying who will do each piece of the implementation.

Vedat's comment could be put directly in the second section, and the first section could be done in minutes. It seems like we would need to work primarily on the last two sections. Since the UML diagram section explicitly excludes GUI classes, I think we should detail the design of the back-end code in that section. The last section could be easily done as well.

[vedxyz]

I think for the diagram of the organization/architecture in System Overview, we could have a very simple illustration showing how the different applications in the project will come into play. For example, by connecting;

• the databases to the main process/server
• the users of various account levels to the website
• the website to the main process/server

we could give a basic idea of the organization of the project.

This is similar to what I'm talking about:

Of course, after this simple diagram, we would continue by adding the "technologies" bit, which should be mostly ready as @berkan-sahin says.

[vedxyz]

As for the Core Design Details, while drawing the class diagrams is a given, I think we should also include sequence diagrams afterwards. For one, it should help with making the report more creative, which is apparently something we currently lack. And also, from what I've read, sequence diagrams seem to be one of the most useful and common planning tools used in the industry. If this is to be believed, there should be merit in getting to know it better, even if it will introduce a bit of extra work for the report.

Hopefully it may not be a big hassle?

[berkan-sahin]

@friberk Did you submit the file?

[vedxyz]

@berkan-sahin Nope, I told him to hold off on it until morning, as I've been polishing a few things here and there.