Skip to content
This repository has been archived by the owner on Oct 1, 2020. It is now read-only.

Commit

Permalink
Added some screenshots and fixed navbar
Browse files Browse the repository at this point in the history
  • Loading branch information
rochacbruno committed Feb 7, 2018
1 parent b639829 commit dfef763
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 17 deletions.
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: docs test pep8 clean install build publish tree create_env devserver pandoc
.PHONY: docs test pep8 clean install build publish tree create_env devserver pandoc adduser

test: pep8
QUOKKA_MODE=test py.test --cov=quokka -l --tb=short --maxfail=1 tests/
Expand Down Expand Up @@ -50,3 +50,8 @@ devserver:
shell:
$(info "Running quokka shell...")
@cd quokka/project_template; quokka shell


adduser:
$(info "Running quokka adduser...")
@cd quokka/project_template; quokka adduser
68 changes: 53 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,40 +16,48 @@ 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
## Features (some to be implemented)

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

## Quick Start


> NOTE: QuokkaCMS requires Python 3.6+

### Install and run for development mode
> this is the recommended way while 1.0.0 is not released
```bash
git clone https://github.com/rochacbruno/quokka
cd quokka
python3 -m venv venv
. venv/bin/activate
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 hacking the code!

### Or install quokka from PyPI
> May not be stable until 1.0.0 is released
```bash
python3 -m venv venv
. venv/bin/activate
pip3 install quokka
```

> NOTE: QuokkaCMS requires Python 3.6+
### Start a project
#### and start a project

```bash

Expand Down Expand Up @@ -105,25 +113,30 @@ quokka init mywebsite --theme http://github.com/user/theme --modules="commerce,f

> the above looks for `quokka_commerce` and `quokka_foo` in PyPI and installs it
Set important configurations
#### Set important configurations

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

> That is optional, you have to edit `quokka.yml` to tune your settings.
> That is optional, you can to edit `quokka.yml` to tune your settings.
#### Create an admin user
```
quokka adduser
```

### Run your website
#### Run your website

```bash
quokka runserver --port 5000
```

### Access admin interface
#### Access admin interface

http://localhost:5000/admin

### Access your site
#### Access your site

http://localhost:5000

Expand Down Expand Up @@ -265,21 +278,24 @@ Take a look at [Contributing Guidelines](/CONTRIBUTING.md)

### Setup a contributor environment

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

```bash
git clone https://github.com/$YOURNAME/quokka_ng
cd quokka_ng
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 flit)
# install Quokka in --editable mode (using pbr)
make install
# Create a new admin user
make adduser
# run quokka
make devserver
```
Expand All @@ -289,7 +305,29 @@ Access http://localhost:5000/admin and http://localhost

## ROADMAP

This list is available on https://github.com/rochacbruno/quokka_ng/issues
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](https://user-images.githubusercontent.com/458654/35923897-a6f321be-0c08-11e8-95ff-5510862326ea.png)


### Pelican themes compatible

An article showing in Malt theme
![start contributing to quokka project my site](https://user-images.githubusercontent.com/458654/35923881-a128c9d2-0c08-11e8-94b4-813588209f04.png)

The same article using Bootstrap 3 theme

![start contributing to quokka project my site2](https://user-images.githubusercontent.com/458654/35924086-32840ebe-0c09-11e8-861e-db1a66b87326.png)

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


# Start contributing right now!
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
</ul>
<li{% if href == url %}class="active"{% endif %}>
<a class="dropdown-button" href="#!" data-activates="dropdown{{loop.index}}">
{{ name }} <i class="material-icons right">+</i>
{{ name }} <i class="material-icons right">arrow_drop_down</i>
</a>
</li>
{% else %}
Expand Down

0 comments on commit dfef763

Please sign in to comment.