[GSoC Project Proposal]: Update ERDDAP™ page rendering to use a template framework

[ChrisJohnNOAA]

Project Description

Currently ERDDAP™ pages are rendered using StringBuilder to concatenate the HTML. This is done for all of the pages ERDDAP™ renders. The project is to migrate existing ERDDAP™ pages to use a templating framework. The plan is for ERDDAP™ developers to select the framework and migrate an example page to the framework before the project starts.

Once the existing pages are migrated, new features can be built including things like:
Personal "hyperwall"
Improved graphics/graphing

Expected Outcomes

Adopting a templating framework for the HTML generation will help by allowing easier shared components across pages, standardizing headers and footers, and more. It will also make it easier to update and maintain the existing pages.

Skills Required

Java, HTML, CSS, JavaScript

Additional Background/Issues

The main ERDDAP™ repo is here.

Mentor(s)

Chris John (@ChrisJohnNOAA), [email protected]

Expected Project Size

175 hours

Project Difficulty

Intermediate

[MathewBiddle]

You're probably not looking for adding dependencies, but I have become quite enamored with the Python template engine Jinja https://jinja.palletsprojects.com/en/stable/. It makes quick work of html pages. Just sharing an option.

[ChrisJohnNOAA]

Since the pages are rendered from Java currently, I'm planning to use something (TBD what, there are a number of options) that will integrate into Java well (or be Java native).

[Harish-2003]

ERDDAP/erddap#46
ERDDAP/erddap#47
do we need to build this things like these using js?

[ChrisJohnNOAA]

ERDDAP/erddap#46 ERDDAP/erddap#47 do we need to build this things like these using js?

The primary project would be to migrate the existing pages to a template engine (TBD, but something like Thymeleaf, JavaServer Pages, Apache Velocity, FreeMarker, or other options) that is integrated with the existing Java code. Currently pages are constructed by appending strings (containing HTML) to a StringBuilder.

Once the existing pages are migrated to the template engine, those projects you mentioned could be tackled. Most likely they will be predominantly in Java and the template engine, but will also use some JavaScript.

[Harish-2003]

This one looks interesting and I would like to be a part of it can you guide me the further steps that I need to do so that I could get selected for this project
I am good with Java as well as javascript

[ChrisJohnNOAA]

@Harish-2003 I believe the official next step will be for you to submit an application. That window has not opened yet.

In the meantime a way to strengthen your application would be to make a small contribution to the project. You can see the current issues list here: https://github.com/ERDDAP/erddap/issues

If you do want to contribute a fix, let me know what you've selected (by commenting on the issue) and I can provide guidance on how we want to solve it.

If you tell me more about your experience and interests I could also try to recommend a small issue.

As for this project specifically the next step is for me to select what template framework we want to use.

[Anees02]

Hello @ChrisJohnNOAA!

I've built numerous projects using Java and web technologies such as HTML, CSS, and JavaScript.

Could you suggest a small issue for me to work on under your guidance? I'm eager to tackle it and further refine my skills.

[ChrisJohnNOAA]

@Anees02 A good, simple issue that will allow you to see what the current UI is like would be: ERDDAP/erddap#260

If you are working on it I recommend assigning it to yourself so others know not to also work on it.

[Anees02]

definately @ChrisJohnNOAA , i will work on it and will give my best.

Thanks for your response!

[Anees02]

Hello @ChrisJohnNOAA !!, I don't understand how to setup the project, even i try multiple time reading the documentation.
I try using tomcat, is there any easy way?
please specify if possible

[ChrisJohnNOAA]

@Anees02 You can use Jetty to run the server for development. There's some directions here: https://github.com/ERDDAP/erddap/tree/main/development/jetty

[Anees02]

Thanks @ChrisJohnNOAA , I Got it.

[Harish-2003]

Hi @ChrisJohnNOAA i have seen issues https://github.com/ERDDAP/erddap/issues and i am thinking to work upon one of the issue that is provided i will try to make contribution for one of the issue