https://github.com/librum-reader/librum-server

The Librum server
https://github.com/librum-reader/librum-server

Last synced: 3 days ago
JSON representation

The Librum server

• Host: GitHub
• URL: https://github.com/librum-reader/librum-server
• Owner: Librum-Reader
• License: agpl-3.0
• Created: 2022-05-09T13:58:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-08T22:44:13.000Z (5 months ago)
• Last Synced: 2025-01-08T00:01:08.360Z (10 days ago)
• Language: C#
• Homepage: https://librumreader.com
• Size: 839 KB
• Stars: 310
• Watchers: 9
• Forks: 25
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Librum-Server

The Librum-Server includes the API, database, and other fundamental infrastructure required for the "backend" of all Librum client applications and the website.

The server is written in C# using ASP.NET Core. The codebase can be developed, built, run, and deployed cross-platform on Windows, macOS, and Linux.




# Self-hosting 

Librum-Server can easily be self-hosted. This way all your data and books remain on your own devices and are not synchronized to the official cloud.

## 🐋 With Docker

Librum-Server can be run with Docker. We provide a [docker-compose.yml](docker-compose.yml) file as well as our own images. We are using GitHub's `ghrc.io` Container Registry.

```bash

wget https://github.com/Librum-Reader/Librum-Server/raw/main/docker-compose.yml

docker compose up -d

```

## 📃 Manual installation

If you don't like Docker, you can also selfhost Librum-Server by running it as a service on your linux server. Instructions can be found [here](self-hosting/self-host-installation.md).




# Contributing

Feel free to reach out to us via email ([email protected]) or discord (m_david#0631) if you are interested in contributing.





We are following a pull request workflow where every contribution is sent as a pull request and merged into the dev/develop branch for testing.

Please make sure to keep to the conventions used throughout the application and ensure that all tests pass, before submitting any pull request.