Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 4.15 KB

README.md

File metadata and controls

71 lines (51 loc) · 4.15 KB
Raw

📚 TeaTime

TeaTime is a fully static distributed library system powered by IPFS, SQLite, and GitHub


Auto-updating instances are hosted on Netlify and GitHub Pages

A Distributed Library

The TeaTime web application is completely decoupled from its databases and the files it fetches. The databases used in TeaTime are GitHub repositories tagged with the teatime-database topic, which are published on GitHub Pages. Each repository contains a config.json file that points to an SQLite database. Before a user performs a search in TeaTime, they choose which database to use and then TeaTime queries the SQLite database using sql.js-httpvfs. Each row in the SQLite database is an item in the library, and a file hash column is used for getting the item from IPFS.

Since the web application is a static site, and the databases are comprised of static files, both can be easily forked, replicated, and deployed. Frontend instances are GitHub repositories tagged with the teatime-instance topic. With the files being served off IPFS, this distributed architecture contributes to TeaTime's resilience.

Features

  • Search by title, author, year or format
  • Maintain reading history, and return to page when re-opening file
  • Download files locally
  • Cache files in IndexedDB for fast loading
  • Drop files on TeaTime to render them
  • Dark mode and full screen mode
  • No cookies, no login
  • ...Completely distributed

Developing the Frontend

TeaTime is Nuxt.js application. You can easily run it locally by cloning the repository and following these steps:

  1. Install the dependencies: npm install
  2. Run the server: npm run dev
  3. Navigate to http://localhost:3000

Check out the Nuxt documentation for more information.

Creating a Database

Tip

The easiest way to create your own database is by forking the JSON-based database repository and adjusting the JSON files according to your needs. GitHub Actions will then generate an SQLite file and upload it to GitHub Pages.

To manually generate an SQLite database that TeaTime can work with, follow the example on the database repository.

Each SQLite database contains a table with the below schema. Note that column names can be adjusted in the config.json file.

CREATE TABLE "books" (
 "id" INTEGER,
 "title" TEXT,
 "author" TEXT,
 "year" INTEGER,
 "lang" TEXT,
 "size" INTEGER,
 "ext" TEXT,
 "ipfs_cid" TEXT,
 PRIMARY KEY("id" AUTOINCREMENT)
);

The dbConfig section of config.json is identical to the output of the sql.js-httpvfs create_db.sh script.

If the SQLite file is too big, you can split it. Note the information about optimizing your database. You will also want to use FTS. Then, publish your repository to GitHub Pages and assign the teatime-database topic to your repository.

Contributing

Even if you cannot code, a great way to contribute is to simply fork this repository, as well as your favorite database repositories. If you fork the repository, it could be better to do it manually (git clone && git remote add your-origin ... && git push your-origin main) so that the repositories won't be directly linked.

It's also a good practice to star the database repositories you find useful, as this determines their order in the TeaTime user interface, making it easier for other users to find the best databases.