quokka 0.3.0

Install quokka

$ pip install quokka

NOTE: QuokkaCMS runs only in Python 3.6+

Start a project

$ quokka init mywebsite
Generating new quokka project in ~/mywebsite

The above command will generate your project files as:

theme\       # Pelican theme files
uploads\     # Files uploaded by you via admin interface
database\    # JSON database if using TinyDB (default)
plugins\     # Plugins (some generated by default)
build\       # Whwn static HTML is generated file output goes here
setting.yml  # Configurations
manage.yml   # Command line interface `quokka manage <command name>`

You can optionally pass arguments:

$ quokka init mywebsite --theme http://github.com/user/theme

Run your website

$ quokka manage runserver --port 5000

(optional) Populate with sample database

$ quokka manage sample_database

Access admin interface

http://localhost:5000/admin

Access your site

http://localhost:5000

You can generate a static HTML website to host anywhere

Once you have your website running locally you can easily generate a static HTML website from it.

$ quokka freeze
Generating static HTML website on ./build folder

Once you have a ./build folder populated with static website you can deploy it using SCP, FTP or git.

Deploying to github pages from command line.

$ quokka publish --static --git=rochacbruno/mysite --branch=gh_pages

The above is also available in admin under ‘publish’ menu.

Deploying via SCP

$ quokka publish --static --scp --dest='me@hostname:/var/www/mysite'
password : ...
# you can pass --key to use it instead of password

Deploying yo Heroku

$ quokka publish --static --heroku --options

Deploying via FTP

$ quokka publish --static --ftp --host='ftp://server.com' --dest='/var/www/mysite'

Load database from remote deployment (only for TinyDB)

When you publish a static website along with the static files the database also goes to the server under the databases/ folder only as a backup and snapshot.

You can load that remote database locally e.g: to add new posts and then re-publish

$ quokka restoredb --remote --git=rochacbruno/mysite
Creating a backup of local database...
Downloading remote database
Restoring database..
Done...

Now you can run quokka runserver open your localhost:5000/admin write new content and then Publish website again using command line or admin interface.

If you want to restore a local database use –local and –path