Notify

A notification broadcasting system that allows users to send categorized messages to multiple channels.

It will be 3 message categories:

Sports
Finance
Movies

And 3 types of message delivery channels:

SMS
E-Mail
Push Notification

Running

Start dockerized PostgreSQL

docker compose up -d

Run migrations:

lein migratus migrate

For repl run:

lein repl

For production run:

lein uberjar
java -jar  target/uberjar/notify-0.1.0-SNAPSHOT.jar

Tests

Executing all tests

lein test

Architecture

There is a single executable application serving a RestAPI and a server side generated simple Web App. The endpoints available are for the Submission of Messages and fetching the Log History.

Data from the messages are persisted in PostgreSQL DB.
Configuration is managed by Aero, credentials aefined according to a config.edn file via JDBC driver.
For building the SQL queries HoneySQL is used.
The HTTP server uses Pedestal.

Dependency tree:

Dependencies / Stack

Clojure (runtime language)
Component (dependency injection)
Aero (config sourcing)
Pedestal (Webserver)
clojure.spec (Validation)
JDBC (RDBMS interface)
HoneySQL (query formatting)
Hiccup (HTML / DOM Elements)
Frontend (rendered on server)

System Components

Config

Allow to set database credentials and webserver port.

Database

Persistency layer to store messages

Users

Manages the user authentication and data

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

VictorInacio / notify