rookeries
/
rookeries
1
0
Fork 0
Code Issues 11 Pull Requests Projects Releases Wiki Activity
A developer and designer friendly web platform for building gorgeous sites, blogs and portfolios.
1,105 Commits 6 Branches 20 Tags 44 MiB
Rust 59.9%
JavaScript 21.1%
CSS 7.9%
Shell 4.9%
Dockerfile 3.2%
Other 3%
Go to file
Dorian a5dd631fa8 Improve footer for demo site. 2017-10-25 08:57:19 -04:00
.circleci Combine tests for code linting in both Python and JS. 2017-10-24 22:49:14 -04:00
docs Add changelog notes on upcoming release. 2017-10-25 01:03:04 -04:00
rookeries Workaround user not sent as part of token response. 2017-10-25 08:35:55 -04:00
scripts Add tagged releases, and remove old script for tags. 2017-03-27 17:38:28 -04:00
src Add option to logout user. 2017-10-25 08:53:45 -04:00
static Migrate footer to use Markdown blocks. 2017-09-29 09:27:56 -04:00
tasks Improve footer for demo site. 2017-10-25 08:57:19 -04:00
templates Fix up feature tests and rendering of page setup. 2017-10-20 15:43:39 -04:00
tests Fix up menus and make compelling fake content for test site. 2017-10-24 20:47:50 -04:00
.babelrc Migrate views to use bootstrap 4 and reactstrap. 2017-09-22 00:08:03 -04:00
.docker-repository.yml Update CI scripts to work against a single image. 2017-03-14 21:14:21 -04:00
.dockerignore Improve testing setup for UI. 2017-04-10 08:15:01 -04:00
.eslintrc.json Improve JS code consistency. 2017-09-25 13:12:10 -04:00
.gitignore Migrate webapp to top level part of project. 2017-03-14 16:02:42 -04:00
Dockerfile Ensure development packages are installed. 2017-10-21 22:01:17 -04:00
Makefile Combine tests for code linting in both Python and JS. 2017-10-24 22:49:14 -04:00
Pipfile Install last dependency using pipenv. 2017-10-21 21:46:39 -04:00
Pipfile.lock Install last dependency using pipenv. 2017-10-21 21:46:39 -04:00
docker-compose.yml Disable for SQL based code. 2017-10-17 23:02:53 -04:00
package.json Fix JS test failures. 2017-10-17 18:13:33 -04:00
readme.md Update documentation about using CouchDB instead of PostgreSQL. 2017-10-25 01:00:28 -04:00
webpack.config.babel.js Migrate webpack configuration to use ES2017. 2017-10-17 17:48:40 -04:00
yarn.lock Remove unused code and libraries. 2017-10-04 20:50:19 -04:00

readme.md

Rookeries

A developer and designer friendly CMS for building gorgeous micro-sites, blogs and portfolios.

Rookeries is:

  • Powered by Flask, Python and CouchDB on the server side.
  • Uses preact, redux, ES2017 and webpack to build responsive single page apps.
  • Licensed under the Affero GNU General Public License (AGPL) version 3.0.

Build Status:

  • CircleCI: CircleCI
  • Docker:

Installation

Rookeries is heavily under development and once things stabilize there will be a user friendly installation guide. In the meantime, please refer to the development guide below.

Development

Rookeries uses the following technologies:

  • Python 3.6
  • NodeJS 8 + ES2017
  • CouchDB 2x
  • Docker + docker-compose

Getting Started

Rookeries requires newer versions of Docker (<1.9.0) and docker-compose (<1.8.0).

  1. Install docker-compose
  2. Build Rookeries: make build
  3. Run tests: make test
    • make test-api to run API server tests.
    • make test-ui to run UI tests.
  4. Run demo: make demo
  5. Run the invoke scripts on a running Rookeries container with: docker-compose exec rookeries inv $MY_TASK
    • Use inv -l to list the available invoke tasks.
  6. When running the demo, navigate to the main Rookeries page in a browser: http://localhost:5000/

Tips and Tricks