anais_berck
/
pagedjs-flask-boilerplate
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3 Commits
1 Branch
0 Tags
252 KiB
JavaScript 98.5%
Python 0.8%
CSS 0.5%
HTML 0.2%
 
 
 
 
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c47f272382'
${ noResults }
Go to file
Gijs c47f272382 Made run.sh executable. 2 years ago
static Initial commit. 2 years ago
templates Initial commit. 2 years ago
.gitignore Added settings.py to gitignore, added urls to Readme. 2 years ago
README.md Added settings.py to gitignore, added urls to Readme. 2 years ago
app.py Initial commit. 2 years ago
pagedjs.py Initial commit. 2 years ago
requirements.txt Initial commit. 2 years ago
run.sh Made run.sh executable. 2 years ago
settings.example.py Initial commit. 2 years ago
utils.py Initial commit. 2 years ago

README.md

The boilerplate uses the python framework flask to run the webinterface and to generate the HTML of the book. To generate the PDF it uses the javascript library pagedjs together with the chromium webbrowser in headless mode.

Installation

First download it on gitlab.

Or clone the repository:

git clone git@gitlab.constantvzw.org:anais_berck/pagedjs-flask-boilerplate.git

This boilerplate uses Python 3 and the framework Flask.

Find information on how to install python here

To install the requirements, move to the directory this readme is located, and then run:

pip install -r requirements.txt

Then install pagedjs-cli, with the command:

npm install -g pagedjs-cli

Finally edit a copy of settings.example.py and save it as settings.py. It is important to set the PAGEDJS_BINARY_PATH, you should be able to find it by running: whereis pagedjs-cli.

Now you should be able to start the interface with: ./run.sh.

Deployment

Todo

Note: this boilerplate does not make any effort at rate-limiting.