All Projects → quokkaproject → Quokka

quokkaproject / Quokka

Licence: other
LOOKING FOR NEW MAINTAINER - Quokka is a Content Management System - `docker run --rm -it -p 5000:5000 quokka/quokka`

Programming Languages

python
139335 projects - #7 most used programming language
HTML
75241 projects

Projects that are alternatives of or similar to Quokka

Textpattern
A flexible, elegant, fast and easy-to-use content management system written in PHP.
Stars: ✭ 572 (-73.98%)
Mutual labels:  cms, content-management, content-management-system, cmf
vscode-front-matter
Front Matter is a CMS running straight in Visual Studio Code. Can be used with static site generators like Hugo, Jekyll, Hexo, NextJs, Gatsby, and many more...
Stars: ✭ 962 (-56.23%)
Mutual labels:  static-site-generator, static-site, content-management, content-management-system
Laravel 8 Simple Cms
Laravel 8 content management system for starters.
Stars: ✭ 444 (-79.8%)
Mutual labels:  cms, content-management, content-management-system
Platform
A modular multilingual CMS built with Laravel 5.
Stars: ✭ 719 (-67.29%)
Mutual labels:  cms, cmf, framework
Zola
A fast static site generator in a single binary with everything built-in. https://www.getzola.org
Stars: ✭ 7,823 (+255.91%)
Mutual labels:  cms, static-site-generator, content-management-system
Pyrocms
Pyro is an experienced and powerful Laravel PHP CMS.
Stars: ✭ 3,086 (+40.4%)
Mutual labels:  cms, cmf, framework
Publii
Publii is a desktop-based CMS for Windows, Mac and Linux that makes creating static websites fast and hassle-free, even for beginners.
Stars: ✭ 3,644 (+65.79%)
Mutual labels:  cms, static-site-generator, static-site
Laracms
LaraCMS 是在学习 laravel ( web 开发实战进阶 + 实战构架 API 服务器) 过程中产生的一个业余作品,试图通过简单的方式,快速构建一套基本的企业站同时保留很灵活的扩展能力和优雅的代码方式,当然这些都得益Laravel的优秀设计。同时LaraCMS 也是一个学习Laravel 不错的参考示例。
Stars: ✭ 588 (-73.25%)
Mutual labels:  cms, content-management, content-management-system
Scrivito example app js
Scrivito is a JavaScript-based SaaS Content Management Service, built for digital agencies and medium to large sized businesses. This example app shows Scrivito’s features and is a great basis for your own Scrivito website projects.
Stars: ✭ 67 (-96.95%)
Mutual labels:  cms, content-management, content-management-system
Strapi
🚀 Open source Node.js Headless CMS to easily build customisable APIs
Stars: ✭ 41,786 (+1801.09%)
Mutual labels:  cms, content-management, content-management-system
Personal Management System
Your web application for managing personal data. <[email protected]>
Stars: ✭ 2,027 (-7.78%)
Mutual labels:  cms, content-management, content-management-system
Verless
A simple and lightweight Static Site Generator.
Stars: ✭ 276 (-87.44%)
Mutual labels:  static-site-generator, static-site, content-management-system
Contentify
Contentify is an esports CMS based on the PHP framework Laravel
Stars: ✭ 189 (-91.4%)
Mutual labels:  cms, content-management, cmf
Anchor Cms
A lightweight blog CMS for PHP
Stars: ✭ 3,359 (+52.82%)
Mutual labels:  cms, content-management, framework
Hugo
The world’s fastest framework for building websites.
Stars: ✭ 55,899 (+2443.18%)
Mutual labels:  cms, static-site-generator, content-management-system
Slimcms
SlimCMS - lightweight CMS based on slim 3 framework
Stars: ✭ 201 (-90.86%)
Mutual labels:  cms, content-management, cmf
Cms
Multilingual PHP CMS built with Laravel and bootstrap
Stars: ✭ 2,342 (+6.55%)
Mutual labels:  cms, content-management, content-management-system
Nodercms
轻量级内容管理系统,基于 Node.js + MongoDB 开发,拥有灵活的内容模型以及完善的权限角色机制。
Stars: ✭ 990 (-54.96%)
Mutual labels:  cms, mongodb, framework
Publiccms
现代化java cms,由天津黑核科技有限公司开发,轻松支撑千万数据、千万PV;支持静态化,服务器端包含; 目前已经拥有全球0.0002%的用户,语言支持中、繁、日、英;是一个已走向海外的成熟CMS产品
Stars: ✭ 1,750 (-20.38%)
Mutual labels:  cms, static-site-generator, static-site
October
Self-hosted CMS platform based on the Laravel PHP Framework.
Stars: ✭ 10,740 (+388.63%)
Mutual labels:  cms, cmf, framework

Quokka

quokka

The Happiest CMS in the world

Quokka is a Content Management Framework written in Python.

A lightweight framework to build CMS (Content Management System) as websites, portals, blogs, applications and anything related to publishing content to the web.

Quokka is not limited to CMS area, it is also possible to create Quokka extensions to provide any kind of web application based on Python and Flask.

Quokka can also (optionally) generate a static website from the contents generated in its admin interface.

Features

  • Web based content management admin interface
  • Multiple content formats (markdown, rst, html, plaintext)
  • Compatibility with any of the Pelican Themes
  • Flat file NoSQL database TinyDB or optionally MongoDB for scale deployments
  • Host the Quokka on server or generate a static website
  • Extensible via modules/plugins
  • Powered by Python, Flask, Flask-Admin, TinyMongo and Pelican Themes

Demo

Use this if you want to see how Quokka works

docker run --rm -it -p 5000:5000 quokka/quokka

Go to http://localhost:5000/admin and login using admin/admin

Quick Start

NOTE: QuokkaCMS requires Python 3.6+

To install and run for development mode

Use this if you want to contribute to quokka, PyPi releases will be provided soon.

git clone https://github.com/rochacbruno/quokka
cd quokka
python3 -m venv venv
. venv/bin/activate
pip3 install --upgrade pip
make install
make adduser
make devserver

then access http://localhost:5000 and http://localhost:5000/admin edit the quokka/project_template/quokka.yml and start contributing to the code!

NOTE: In dev mode the project in quokka/project_template/ is used and a database is created inside it.

To install for use/deployment

NOTE: this project is a Work In Progress, consider installing in development mode

python3 -m venv venv
. venv/bin/activate
pip3 install --upgrade pip
pip3 install -e git+https://github.com/rochacbruno/quokka.git#egg=quokka
quokka init mysite
cd mysite
quokka adduser
quokka runserver

Using Quokka CMS

Start a project

$ quokka init NewWebsite --theme=flex --modules=gitpages,heroku
...
🐹 Quokka project created 🐹
📝 Name: NewWebsite
📁 Location: /tmp/newwebsite
📚 Template: default
🎨 Themes: flex theme installed
🚚 Modules: [gitpages, heroku] installed
🔧 Config: Config file written in /tmp/newwebsite/quokka.yml
➡ Go to /tmp/newwebsite
⚙ run `quokka runserver` to start!
📄 Check the documentation on http://quokkaproject.org
🐹 Happy Quokka! 🐹

YES! it outputs emojis 🐹

The above command will generate your project in myproject folder as:

.
├── databases        # TinyDB database files (gitignored)
├── modules          # Custom modules to load on EXTRA_EXTENSIONS
├── static_build     # output static site
├── themes           # Front-end Themes (Pelican and Quokka Themes supported)
├── uploads          # Media uploaded via admin
├── .gitignore       # gitignore to exclude sensitive files
├── quokka.yml       # Project settings
├── .secrets.yml     # To store keys, tokens and passwords (gitignored)
└── wsgi.py          # To deploy `gunicorn wsgi:app`

You can optionally pass arguments:

Choose existing theme (the default is Malt)

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

Install modules

quokka init mywebsite --theme http://github.com/user/theme --modules="commerce,foo"

the above looks for quokka_commerce and quokka_foo in PyPI and installs it

Set important configurations

quokka init mywebsite --theme http://github.com/user/theme --config="auth_enabled=false"

That is optional, you can to edit quokka.yml to tune your settings.

Create an admin user

quokka adduser

Run your website

quokka runserver --port 5000

Access admin interface

http://localhost:5000/admin

Access your site

http://localhost:5000

Deploy

You can deploy your Quokka Website in a WSGI server

Check the wsgi.py and refer to it when deploying in wsgi servers.

cd myproject
gunicorn wsgi:app -w 4 -b "0.0.0.0:8000"

An example of supervisord config

[program:quokka]
command=/myproject/venv/bin/gunicorn wsgi:app -w 4 -b "0.0.0.0:8000"
directory=/myproject

For more information read Gunicorn documentation

Publish Static HTML website

NOTE: To generate a static website all user management, keys and passwords will be removed from settings.

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 publish --static [--output path]
Generating static HTML website on ./static_build folder

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

Deploying to github pages from command line

NOTE: You need either ssh key access to github or it will ask login/password

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' [--sshkey ~/.ssh/key] [--password xyz]
password : ...

Deploying to Heroku

This requires heroku client installed, if Procfile is not found it will be generated

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.

NOTE: If you want to restore a local database use --local and --path path/to/db

Using MongoDB

You can choose to use MongoDB instead of TinyDB, That is useful specially if you deploy or local instance has more than one admin user concurrently and also useful if you want to install plugins which support MongoDB only (because it relies on aggregations and gridfs)

You only need a running instance of Mongo server and change quokka.yml:DB on your project from:

quokka:
  DB:
    system: tinydb
    folder: databases

to:

quokka:
  DB:
    system: mongodb
    name: my_database
    host: 127.0.0.1
    port: 2600

Then when running quokka again it will try to connect to that Mongo Server.

With that you can deploy your site on wsgi server or can also generate static website.

Running mongo in a Docker container

cd your_quokka_project_folder
docker run -d -v $PWD/databases:/data/db -p 27017:27017 mongo
# wait some seconds until mongo is started
quokka runserver

Contributing to Quokka CMS Development

Do you want to be part of this open-source project?

Take a look at Contributing Guidelines

Setup a contributor environment

Ensure you have Python3.6+ fork this repo and:

git clone https://github.com/$YOURNAME/quokka
cd quokka

# create a Python3.6 virtual env
make create_env

# activate the venv
. venv/bin/activate

# install Quokka in --editable mode (using pbr)
make install

# Create a new admin user
make adduser

# run quokka
make devserver

Access http://localhost:5000/admin and http://localhost

ROADMAP

This list is available on https://github.com/rochacbruno/quokka/issues

This is the list of tasks to be completed until 1.0.0 can be released. support 100% coming only for malt and bootstrap3 themes

Screenshots

The main Admin page

home cms

Pelican themes compatible

An article showing in Malt theme

start contributing to quokka project my site

The same article using Bootstrap 3 theme

start contributing to quokka project my site2

See more on screenshots on https://github.com/rochacbruno/quokka/issues/647

Start contributing right now!

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].