soapdog / little-webby-press

A PWA to generate eBooks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Little Webby Press

This is a webapp project to help authors generate eBooks and static websites.

More information about this project in this teaser video.

Development

This project is done with NodeJS and Svelte.

Editor gotcha

VSCode svelte plugin has a mind of its own and is overriding the configurations of prettier and editorconfig. It keeps using single quotes even though all the configuration files says for it to use double quotes. Every time I format a source file, it reverts the double quotes into single quotes inside the svelte template section. I'm tired of fighting this and will worry about it later, already lost a whole day on this stupid thing.

Setup

Just install the dependencies with:

PS> npm install

Running

To run in development mode:

PS> npm run dev

Updating templates

The templates are served as zipfiles. They are not a part of the application bundle. To update them you need to run the pack-templates.sh shell script (or pack-templates.bat in case you're on Windows). The webapp will load the zip and unpack the templates in a temporary filesystem.

Bundled tools

To help during development, this repo is bundling epubcheck 4.2.3 and has two batch files to help inspect generated books.

  • check.bat <path to epub>: will run the given epub through epubcheck.
  • edit.bat <path to epub>: will copy and unzip the epub and open the epub in Visual Studio Code Insiders. If you're using a different editor, please replace the final edit command there.
  • remove.bat <path to epub>: Deletes the epub and the expanded epub dir created by edit.bat. Be aware that if you have spaces in your path, you need to quote them properly or this will delete the wrong folder.

I'm using these batch files all the time as I work through the epub generation and decided they are useful enough that other people might want to use them too. They are not needed for this web app to work, it is just helpful during development.

PS: Shell scripts to perform the same functions are also provided.

LICENSE

MIT

About

A PWA to generate eBooks

License:MIT License


Languages

Language:CSS 79.6%Language:JavaScript 9.9%Language:Svelte 5.1%Language:Handlebars 4.7%Language:Lua 0.5%Language:Shell 0.1%Language:Batchfile 0.1%