RRSS by FOSSkeeters

Disclaimer

This repository exists purely for archival purposes. Any referenced issues, pull requests and releases have been /dev/null’ed and shall remain permanently unreachable.

Requirements

• OpenJDK >= 21
• Docker (production only)
• Docker Compose (production only)
• Spring Boot Extension Pack for VSCode (optional)

Build and Run (for local builds)

IntelliJ

IntelliJ automatically detects, indexes, and builds the project by itself. All you have to do just click the Run icon at the top right.

The website should be accessible from localhost:8080

CLI

You can immediately run the application with the command below:

./gradlew bootRun

If you would like to make the program hot-reload i.e. restart everytime there is a change in the codebase, then you can run this command in addition to the one above:

./gradlew build --continuous -x test

The website should be accessible from localhost:8080

Build and Run (for production builds)

Build and run the docker container with:

docker compose up --build

The website should be accessible from localhost:8520. The port number can be changed by editing the compose.yaml file.

Database Path

The default path for the database file is ./rrss.sqlite. This can be easily overriden by setting the environment variable DB_PATH to desired path.

License

This project is released under the terms of the GNU Affero General Public License version 3. Check out the LICENSE file in this repository for details.