Alamantus
/
little-library
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
A digital give-a-book, take-a-book library for ebooks https://library.quietplace.tk
41 Commits 2 Branches 0 Tags 132 KiB
JavaScript 64.4%
HTML 29.9%
CSS 5.7%
Go to file
Robbie Antenesse 24a2991292 Merge branch 'styling' 2019-01-26 13:02:07 -06:00
public Add a button to toggle styled bookshelf 2019-01-26 12:59:01 -06:00
routes Merge branch 'styling' 2019-01-26 13:02:07 -06:00
templates Add a button to toggle styled bookshelf 2019-01-26 12:59:01 -06:00
.gitignore Add lines for enabling https 2019-01-07 11:23:59 -07:00
Procfile Add Heroku-specific stuff 2019-01-04 18:06:14 -07:00
README.md Update readme to include https settings & explanations 2019-01-07 12:02:27 -07:00
package.json Add a button to toggle styled bookshelf 2019-01-26 12:59:01 -06:00
server.js Move fillTemplate to Templater class 2019-01-10 16:13:21 -07:00
settings.example.json Add a tool to reset visitors count 2019-01-08 16:15:06 -07:00
yarn.lock Add a button to toggle styled bookshelf 2019-01-26 12:59:01 -06:00

README.md

# Little Library

A digital give-a-book, take-a-book library for ebooks.

Features

  • Free Contribution: allows DRM-free ebooks to be uploaded by anyone
  • Built-in Reviews: requires a description/reason/note for uploading
  • Small Footprint: only allows ebook files and limited metadata and optional library size limit
  • Digital Physicality: know when you're not the only one visiting the little library
  • Single-borrower: removes ebook files from server when someone takes it
  • Metadata history: keeps a history of all books that have been on shelf

Requirements

Installation

Clone the repo:

> git clone https://github.com/Alamantus/little-library.git

Navigate to the folder:

> cd path/to/little-library

Run yarn to install all the dependencies:

> yarn

Then copy settings.example.json to settings.json and make sure everything is to your liking. Below is the default settings.example.json file:

{
  "port": 3000, // The server's port
  "siteTitle": "Little Library",  // The name that appears in the site header
  "titleSeparator": " | ",  // The separator for the browser bar's title between page and site titles
  "fileLocation": "./public/files/",  // The relative path to where the ebook files will be served from
  "historyLocation": "./public/history/", // The relative path to where the history metadata files will be served from
  "maxLibrarySize": 0,  // The maximum number of books that can be added to the library. 0 means unlimited
  "maxFileSize": 0, // The maximum file size of an ebook allowed to be uploaded. 0 means unlimited
  "maxHistory": 0,  // The maximum number of history metadata files that will be saved on your server. 0 means unlimited
  "allowedFormats": [".epub", ".mobi", ".pdf"], // The file formats allowed to be uploaded
  "backupPassword": "password",  // The plaintext password that allows you to access the /backup features. Be sure to change this before going live!
  "hideVisitors": false,  // If true, the "Current Visitors" counter will not update on the front end
  "sslPrivateKey": null,  // The ssl private key received from your certificate authority for HTTPS support
  "sslCertificate": null, // The ssl certificate received from your certificate authority for HTTPS support
  "sslCertificateAuthority": null,  // The ssl certificate authority (CA) received from Let's Encrypt for HTTPS support
  "forceHTTPS": false // Redirect all traffic for http to https (not sure why you wouldn't want this)
}

Usage

Run npm start to start the Little Library server:

> npm start

Navigate to localhost:3000 in your favorite browser to see the Little Library.

The Little Library allows anyone with access to it to give or take ebooks. I'll write a more in-depth bit about how exactly to use it when I have some more time.

Management

There is a backup utility located at the /backup path when running the server, i.e. http://localhost:3000/backup. In order to utilize it, you need to include your backupPassword in the url, like this:
http://localhost:3000/backup?pass=password

This utility allows you to download a .zip file of all the ebook and history files on your server and then re-upload those same .zip files back to another server. This is helpful if you use a service like Heroku that does not persist your files when you re-upload the core script files.