Article Hosting Website

A website that stores and displays "articles" to the user.

Project Structure

/news-site contains all website source code and assets.

/runner contains a Maven plugin for running modular Java applications, designed to run the news-site.

Software Used

Maven

For building, testing, and running. Follows standard build system structure. The build script requires a Java .properties file /news-site/project.properties with the following properties:

# Optional path to a PKCS #12 file
keystore = <path>
# Keystore password (used as password and keygen seed (NOT SECURE) for self-signed cert if keystore is absent)
password = <password>
# Human-readable organization name for self-signed cert
organization = <name>
#DNS name for the server used by self-signed cert, TLS, and other functionality
hostname = <domain>
#Website title text used in various places
title = <name>

To automatically build and run the server using Maven, in the root directory of the project run

mvn net.ritzow:runner:1.4-SNAPSHOT:run

Jetty Embedded HTTP Server

For HTTP 1.1/2/3 web server functionality and utilities.

j2html

For dynamically generating all HTML served.

HyperSQL (HSQLDB)

For article storage (currently in-memory).

Hikari Connection Pool

For proper database functionality in application threads started by Jetty.

commonmark-java

For parsing article Markdown and converting it to HTML.

SLF4J

Used by libraries for logging.