ChrisBlanks / flipbook

Small project for creating a flipbook via the TurnJs library

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

About

An interactive book app that allows the reader to choose their own story. Most of the logic is related to using the TurnJs library to display the parsed text from a book. The only supported file format is a text file (.txt). See the special notes section for the book content format within the the file.

Book Reader UI

Project can be viewed in GithubPages page: Live Demo

Building

To setup project after cloning, run npm install in the top level directory.

Execute npm run build to package source code into a bundle via webpack. Build artifacts will appear in the dist/ directory.

Use npm run server or npx vite to run server. Should be able to see build artifacts if dist/ directory is added to url. use npx vite build to build prod version and run in server

Special Notes

The book text must be in the following format:

Title : [Book Title]

Chapter [#]: [Chapter title]
[Chapter text]

[Chapter choices]
[Chapter choices]

.
.
.

Chapter [Last Chapter #]: [Last Chapter title]
[Chapter text]

[Chapter choices]
[Chapter choices]

A "The End" page will be generated as the last page of the book.

About

Small project for creating a flipbook via the TurnJs library


Languages

Language:JavaScript 68.9%Language:HTML 19.2%Language:CSS 11.9%