A developer and designer friendly web platform for building gorgeous sites, blogs and portfolios.
Go to file
Dorian c81897c503 Fix linting issues with spacing. 2017-09-22 23:28:44 -04:00
.circleci Add notes about builds. 2017-09-15 16:15:05 -04:00
docs Add technical notes. 2017-09-13 08:20:45 -04:00
rookeries Make example site work, with upgraded react-router and other components. 2017-09-21 05:36:17 -04:00
scripts Add tagged releases, and remove old script for tags. 2017-03-27 17:38:28 -04:00
src Fix linting issues with spacing. 2017-09-22 23:28:44 -04:00
static Migrate views to use bootstrap 4 and reactstrap. 2017-09-22 00:08:03 -04:00
tasks Setup webpack dev server to run with uwsgi. 2017-09-13 09:04:39 -04:00
templates Migrate views to use bootstrap 4 and reactstrap. 2017-09-22 00:08:03 -04:00
tests Skip tests related to sites. 2017-09-13 22:39:16 -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 Fix linting issues with spacing. 2017-09-22 23:28:44 -04:00
.gitignore Migrate webapp to top level part of project. 2017-03-14 16:02:42 -04:00
Dockerfile Migrate to use standalone prop types. 2017-09-18 08:46:05 -04:00
Makefile Fix Makefile test issue. 2017-09-16 08:31:46 -04:00
Pipfile Migrate views to use bootstrap 4 and reactstrap. 2017-09-22 00:08:03 -04:00
Pipfile.lock Migrate views to use bootstrap 4 and reactstrap. 2017-09-22 00:08:03 -04:00
docker-compose.yml Update configuration and hopefully fix the issues with CircleCI builds. 2017-09-15 15:37:25 -04:00
package.json Fix linting issues with spacing. 2017-09-22 23:28:44 -04:00
readme.md Add support to visually debug tests. 2017-03-27 08:47:15 -04:00
requirements.txt Remove coverage reports from tests. 2017-04-06 08:14:00 -04:00
webpack.config.js Migrate views to use bootstrap 4 and reactstrap. 2017-09-22 00:08:03 -04:00
yarn.lock Fix markdown renderer. 2017-09-22 18:57:18 -04:00

readme.md

Rookeries

A developer and designer friendly web platform for building gorgeous sites, blogs and portfolios.

Rookeries is:

  • Powered by Flask, Python and PostgreSQL on the server side.
  • Uses React, Redux, ES6 and LESS 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 2.7
  • NodeJS 6.9 + ES6
  • PostgreSQL 9.6
  • Docker + docker-compose
  • Make

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