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,234 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 50472613d9 Break out web server to standalone module. 2018-07-27 16:26:50 -04:00
.circleci Combine tests for code linting in both Python and JS. 2017-10-24 22:49:14 -04:00
docs Update documentation. 2017-12-12 10:48:38 -05:00
js-src Rename client source in preparation for Rust transition. 2018-07-18 08:31:39 -04:00
rookeries Fix style issues to resolve the build issues. 2018-07-27 12:52:13 -04:00
scripts Add tagged releases, and remove old script for tags. 2017-03-27 17:38:28 -04:00
src Break out web server to standalone module. 2018-07-27 16:26:50 -04:00
static Migrate footer to use Markdown blocks. 2017-09-29 09:27:56 -04:00
tasks Implement 404 error, and tests. 2018-07-27 04:10:22 -04:00
templates Simplify overall base image. 2017-11-15 08:55:11 -05:00
tests Rename client source in preparation for Rust transition. 2018-07-18 08:31:39 -04:00
.babelrc Upgrade multiple JS libraries to the latest except React. 2017-12-12 08:45:29 -05: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 Upgrade multiple JS libraries to the latest except React. 2017-12-12 08:45:29 -05:00
.gitignore Add a very basic REST API and CLI to start the CMS off. 2018-07-18 08:52:33 -04:00
Cargo.lock Add logging to the web application. 2018-07-26 08:17:37 -04:00
Cargo.toml Add logging to the web application. 2018-07-26 08:17:37 -04:00
Dockerfile Fix Rust build issue and migrate away from yarn. 2018-07-27 11:29:48 -04:00
Makefile Remove unused feature tests. 2018-07-18 08:17:13 -04:00
Pipfile Remove pytest-bdd as dependency. 2017-12-14 08:44:21 -05:00
Pipfile.lock Attempt to resolve docker builds. 2018-07-18 10:22:43 -04:00
dev.env Implemented working logging banner. 2018-07-27 03:11:54 -04:00
docker-compose.yml Disable for SQL based code. 2017-10-17 23:02:53 -04:00
package-lock.json Fix Rust build issue and migrate away from yarn. 2018-07-27 11:29:48 -04:00
package.json Rename client source in preparation for Rust transition. 2018-07-18 08:31:39 -04:00
readme.md Update the readme. 2017-11-02 09:19:23 -04:00
webpack.config.babel.js Rename client source in preparation for Rust transition. 2018-07-18 08:31:39 -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, mobx, 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/

Please refer to the Development Notes for more details.