Sylgar

A simple dynamically routed library written in Svelte. Sylgar is designed primarily for TTRPG books, but can be used for any kind of book.

Installation

1. Ensure you have the prerequisites installed:

   • Node.js
   • npm
   • (Bun can be used as a replacement for node and npm, but is not officially supported)

2. Install Sylgar:

git clone https://github.com/RJMurg/Sylgar.git

3. Install dependencies:

npm install

or

bun install

4. Create a .env file

   touch .env

5. Add the following to the .env file:

   PASSWORD=[chosen password]

6. Build Sylgar: ENSURE THAT YOU HAVE THE CORRECT ADAPTER SPECIFIED IN svelte.config.js

npm run build

or

bun run build

7. Run Sylgar:

node ./build/index.js

or

bun ./build/index.js

Usage

Proper Directory Structure

All books should go in a library directory in static. The directory structure should be as follows:

library
├── book1.pdf
├── book2.pdf
├── DIR1
│   ├── book3.pdf
│   ├── book4.pdf
├── DIR2
│   ├── book5.pdf
│   ├── book6.pdf

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Sylgar is licensed under the MIT license. Please see the docs/LICENSE file for more information.