This repository has been archived by the owner on Oct 1, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 447
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #333 from rochacbruno/development
New model paths and sitemaps released
- Loading branch information
Showing
94 changed files
with
1,861 additions
and
1,221 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| quokka/themes/* linguist-vendored |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -56,4 +56,5 @@ etc/mongodata/*.0 | |
| etc/mongodata/*.ns | ||
| etc/mongodata/*.lock | ||
| etc/mongodata/*.bson | ||
| etc/logs/*.log | ||
| *.log | ||
| *.pid | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| [](https://github.com/pocoo/metaflask) | ||
| [](https://travis-ci.org/quokkaproject/quokka) | ||
| [](https://coveralls.io/r/quokkaproject/quokka) | ||
| [](https://landscape.io/github/quokkaproject/quokka/development) | ||
| [](https://requires.io/github/quokkaproject/quokka/requirements/?branch=development) | ||
| [](https://travis-ci.org/rochacbruno/quokka) | ||
| [](https://coveralls.io/r/rochacbruno/quokka) | ||
| [](https://landscape.io/github/rochacbruno/quokka/development) | ||
| [](https://requires.io/github/rochacbruno/quokka/requirements/?branch=development) | ||
|
|
||
| [](http://waffle.io/quokkaproject/quokka) | ||
| [](http://waffle.io/rochacbruno/quokka) | ||
| [](https://quokkaslack.herokuapp.com/) | ||
| [](https://quokkaproject.slack.com/messages/) | ||
|
|
||
|
|
@@ -13,7 +13,7 @@ | |
| <a target="_blank" href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=rochacbruno%40gmail%2ecom&lc=BR&item_name=quokkaproject&no_note=0&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest"><img alt='Donate with Paypal' src='http://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif' /></a> | ||
|
|
||
| [](https://app.wercker.com/project/bykey/e9cbc4497ee946083aa19fbd3f756c91) | ||
| [](https://openshift.redhat.com/app/console/application_type/custom?cartridges%5B%5D=python-2.7&cartridges%5B%5D=mongodb-2.4&initial_git_url=https://github.com/quokkaproject/quokka.git&name=quokka&initial_git_branch=master) | ||
| [](https://openshift.redhat.com/app/console/application_type/custom?cartridges%5B%5D=python-2.7&cartridges%5B%5D=mongodb-2.4&initial_git_url=https://github.com/rochacbruno/quokka.git&name=quokka&initial_git_branch=master) | ||
|
|
||
| Quokka project | ||
| =============================================== | ||
|
|
@@ -49,20 +49,22 @@ User '[email protected]' and passwd 'admin' to login in to /admin | |
|
|
||
| # Get Quokka | ||
|
|
||
| ## Get Quokka Master and enter in to its root directory | ||
|
|
||
| # Using Docker | ||
|
|
||
| The easiest way to run Quokka for development or production is using quokkaCMS + Gunicorn + Supervisor under a Docker Container. You can see the instructions in the following repository: https://github.com/quokkaproject/docker-gunicorn-supervisor | ||
|
|
||
|
|
||
| ## Get Quokka to run locally for development or deployment | ||
|
|
||
| ```bash | ||
| git clone https://github.com/quokkaproject/quokka --branch master --single-branch | ||
| git clone https://github.com/rochacbruno/quokka --branch master --single-branch | ||
| cd quokka | ||
| ``` | ||
|
|
||
| > if you are cloning to contribute to the project just clone it without the "--branch=master --single-branch" part | ||
| ## Run Quokka | ||
|
|
||
| You have 2 options **RUN LOCAL** or **RUN IN DOCKER** | ||
|
|
||
| ### RUN LOCAL | ||
| ### Run Quokka | ||
|
|
||
| Install needed packages in your local computer | ||
|
|
||
|
|
@@ -94,6 +96,8 @@ You can install everything you need in your local computer or if preferred use a | |
| MONGODB_USERNAME = None | ||
| MONGODB_PASSWORD = None | ||
| ============================================================= | ||
| # You can also use envvars `export QUOKKA_MONGO_DB="yourdbname"` | ||
| ``` | ||
|
|
||
| 3. If you have Docker installed you can simply run the official Mongo image | ||
|
|
@@ -117,7 +121,8 @@ You can install everything you need in your local computer or if preferred use a | |
|
|
||
| #### Python requirements | ||
| Install all needed python packages | ||
| > activate your virtualenv if you want | ||
|
|
||
| > If you have a virtualenv, activate it! `source env/bin/activate` or `workon env` | ||
|
|
||
| ```bash | ||
| pip install -r requirements/requirements.txt | ||
|
|
@@ -135,7 +140,7 @@ pip install -r requirements/requirements.txt | |
| P4$$W0Rd | ||
| ``` | ||
|
|
||
| 4. Populate with sample data (optional if you want sample data) | ||
| 4. Populate with sample data (optional if you want sample data for testing) | ||
| ```bash | ||
| $ python manage.py populate | ||
|
|
@@ -148,68 +153,7 @@ pip install -r requirements/requirements.txt | |
| ``` | ||
| - Site on [http://localhost:5000](http://localhost:5000) | ||
| - Admin on [http://localhost:5000/admin](http://localhost:5000/admin) | ||
|
|
||
|
|
||
| ### RUN IN DOCKER | ||
|
|
||
| - Run pre built docker images with everything pre-installed | ||
| - You will need docker and docker compose installed in your machine | ||
| - Once in Docker all data is stored behind quokka/etc folder | ||
|
|
||
|
|
||
| #### Install Docker and docker-compose | ||
|
|
||
| - **Docker** - https://docs.docker.com/installation/ | ||
| - **Docker-Compose** - https://docs.docker.com/compose/install/ | ||
|
|
||
|
|
||
| > Ensure that local port 27017(mongo) is not being used on your computer | ||
|
|
||
| * ### Run with docker-compose | ||
|
|
||
| 1. Easiest way is just running the following command in quokka root folder | ||
| ```bash | ||
| docker-compose up | ||
| ``` | ||
|
|
||
| > use -d on above to leave it as a daemon | ||
|
|
||
| 2. You can create a new admin user to login and start posting | ||
| ```bash | ||
| docker-compose run web python manage.py accounts_createsuperuser | ||
| ``` | ||
|
|
||
| 3. Or populate with sample data (optional) | ||
| ```bash | ||
| docker-compose run web python manage.py populate | ||
| ``` | ||
| > credentials for /admin will be email: [email protected] passwd: admin | ||
|
|
||
| 4. You enter Quokka Shell (in a separate console) or run any other command in place of **shell* | ||
| ```bash | ||
| docker-compose run web python manage.py shell | ||
| ``` | ||
|
|
||
| * ### Run standalone containers | ||
| > (each in separate shells or use -d option) | ||
|
|
||
| 1. run mongo container | ||
| ```bash | ||
| docker run -v $PWD/etc/mongodata:/data/db -p 27017:27017 --name mongo mongo | ||
| ``` | ||
|
|
||
| 2. run quokka web app container | ||
| ```bash | ||
| docker run -e "QUOKKA_MONGODB_HOST=mongo" -p 5000:5000 --link mongo:mongo -v $PWD:/quokka --workdir /quokka -t -i quokka/quokkadev python manage.py runserver --host 0.0.0.0 | ||
| ``` | ||
|
|
||
| 3. run quokka shell if needed | ||
| ```bash | ||
| docker run -e "QUOKKA_MONGODB_HOST=mongo" -p 5000:5000 --link mongo:mongo -v $PWD:/quokka --workdir /quokka -t -i quokka/quokkadev python manage.py shell | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ## Deployment | ||
|
|
||
|
|
@@ -223,18 +167,18 @@ http://quokkaproject.org/documentation | |
| > If you want to help writing the docs please go to https://github.com/quokkaproject/quokkaproject.github.io | ||
|
|
||
|
|
||
| Also there is a [Wiki](https://github.com/quokkaproject/quokka/wiki) | ||
| Also there is a [Wiki](https://github.com/rochacbruno/quokka/wiki) | ||
| =============================================== | ||
|
|
||
| > NOTE: the content from wiki will be moved to /documentation | ||
|
|
||
| * [About & Features](https://github.com/quokkaproject/quokka/wiki/about) | ||
| * [Installing and running](https://github.com/quokkaproject/quokka/wiki/installation) | ||
| * [Requirements](https://github.com/quokkaproject/quokka/wiki/requirements) | ||
| * [Extending & Installing modules](https://github.com/quokkaproject/quokka/wiki/plugins) | ||
| * [Admin interface](https://github.com/quokkaproject/quokka/wiki/screencast) | ||
| * [Project tree](https://github.com/quokkaproject/quokka/wiki/project-tree) | ||
| * [Team & Committers](https://github.com/quokkaproject/quokka/graphs/contributors) | ||
| * [About & Features](https://github.com/rochacbruno/quokka/wiki/about) | ||
| * [Installing and running](https://github.com/rochacbruno/quokka/wiki/installation) | ||
| * [Requirements](https://github.com/rochacbruno/quokka/wiki/requirements) | ||
| * [Extending & Installing modules](https://github.com/rochacbruno/quokka/wiki/plugins) | ||
| * [Admin interface](https://github.com/rochacbruno/quokka/wiki/screencast) | ||
| * [Project tree](https://github.com/rochacbruno/quokka/wiki/project-tree) | ||
| * [Team & Committers](https://github.com/rochacbruno/quokka/graphs/contributors) | ||
|
|
||
|
|
||
| Hosting | ||
|
|
@@ -245,7 +189,7 @@ You can host a Quokka website in any VPS or cloud which supports Python and Flas | |
| - PythonAnywhere can run Quokka with Mongo hosted at MongoLab | ||
| - DigitalOcean is a good option for a VPS | ||
| - Jelastic Cloud has the easiest Quokka deployment - http://docs.jelastic.com/ru/quokka-cms | ||
| - OpenShift [one click deploy](https://openshift.redhat.com/app/console/application_type/custom?cartridges%5B%5D=python-2.7&cartridges%5B%5D=mongodb-2.4&initial_git_url=https://github.com/quokkaproject/quokka.git&name=quokka&initial_git_branch=master) | ||
| - OpenShift [one click deploy](https://openshift.redhat.com/app/console/application_type/custom?cartridges%5B%5D=python-2.7&cartridges%5B%5D=mongodb-2.4&initial_git_url=https://github.com/rochacbruno/quokka.git&name=quokka&initial_git_branch=master) | ||
|
|
||
|
|
||
|  | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,6 +31,38 @@ | |
| "order" : 0 | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name" : "author", | ||
| "email" : "[email protected]", | ||
| "gravatar_email": "[email protected]", | ||
| "password" : "author", | ||
| "roles" : [ "author" ], | ||
| "bio": "Quokka Example Author", | ||
| "tagline": "It is nice to write in Quokka CMS!", | ||
| "links": [ | ||
| { | ||
| "title" : "facebook", | ||
| "link" : "http://facebook.com/quokkaproject", | ||
| "icon" : "facebook", | ||
| "css_class" : "facebook", | ||
| "order" : 0 | ||
| }, | ||
| { | ||
| "title" : "github", | ||
| "link" : "http://github.com/quokkaproject", | ||
| "icon" : "github", | ||
| "css_class" : "github", | ||
| "order" : 0 | ||
| }, | ||
| { | ||
| "title" : "twitter", | ||
| "link" : "http://twitter.com/quokkaproject", | ||
| "icon" : "twitter", | ||
| "css_class" : "twitter", | ||
| "order" : 0 | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "configs": [ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,6 +31,38 @@ | |
| "order" : 0 | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name" : "author", | ||
| "email" : "[email protected]", | ||
| "gravatar_email": "[email protected]", | ||
| "password" : "author", | ||
| "roles" : [ "author" ], | ||
| "bio": "Quokka Example Author", | ||
| "tagline": "It is nice to write in Quokka CMS!", | ||
| "links": [ | ||
| { | ||
| "title" : "facebook", | ||
| "link" : "http://facebook.com/quokkaproject", | ||
| "icon" : "facebook", | ||
| "css_class" : "facebook", | ||
| "order" : 0 | ||
| }, | ||
| { | ||
| "title" : "github", | ||
| "link" : "http://github.com/quokkaproject", | ||
| "icon" : "github", | ||
| "css_class" : "github", | ||
| "order" : 0 | ||
| }, | ||
| { | ||
| "title" : "twitter", | ||
| "link" : "http://twitter.com/quokkaproject", | ||
| "icon" : "twitter", | ||
| "css_class" : "twitter", | ||
| "order" : 0 | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "configs": [ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.