Serenity

Serenity is a chat application

Elysium

Elysium is a server software for Serenity chat application.

Setup

Prerequisites

1. Docker/Podman -- a container engine is required for running PostgreSQL
2. Python -- Python is required for running setup/test scripts
3. Clojure -- Elysium is written in Clojure, it is required for development

Initial setup

1. Copy project-config.toml.example into project-config.toml:

cp project-config.toml.example project-config.toml

2. Replace with your desired values if needed

Running in Development mode

In project directory, run:

./scripts dev 

Scripts will automatically start PostgreSQL container at pg_port and Elysium at http_port (both defined in project-config.toml under section [run.dev])

Note: scripts are documented, with --help to get documentation on options and arguments:

./scripts dev --help

Running tests

In project directory, run:

./scripts test

Scripts will automatically start PostgreSQL container at pg_port and Elysium at http_port (both defined in project-config.toml under section [run.test]) and run test suite against the running Elysium server. Upon completion the PostgreSQL container will be stopped and deleted.

License

Copyright (C) 2026 dom-lis

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.