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,294 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 2c4d6b885f Migrate more tests over. 2018-08-10 23:17:10 -04:00
.circleci Combine tests for code linting in both Python and JS. 2017-10-24 22:49:14 -04:00
docs Update the package.json and docs in anticipation of the next release of Rookeries. 2018-08-09 11:02:56 -04:00
js-src Get to version parity with Rookeries in Python. 2018-08-08 15:37:10 -04:00
rookeries Remove unused Python REST API. 2018-08-08 16:40:29 -04:00
src Add fix to meet the Rust style guide. 2018-08-08 19:50:09 -04:00
static Migrate footer to use Markdown blocks. 2017-09-29 09:27:56 -04:00
tasks Move API tests up to where the Rust tests will live. 2018-08-10 10:35:38 -04:00
templates Add simple index page for the server. 2018-08-07 14:31:28 -04:00
tests Migrate more tests over. 2018-08-10 23:17:10 -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 Fix up ignores. 2018-08-02 15:32:01 -04:00
.eslintrc.json Upgrade multiple JS libraries to the latest except React. 2017-12-12 08:45:29 -05:00
.gitignore Fix up ignores. 2018-08-02 15:32:01 -04:00
Cargo.lock Transition API status endpoint tests to Rust. 2018-08-10 15:15:12 -04:00
Cargo.toml Transition API status endpoint tests to Rust. 2018-08-10 15:15:12 -04:00
Dockerfile Fix issue with Rust initial caching project setup. 2018-08-08 17:53:26 -04:00
Makefile Add support to add the git revision at build time. 2018-08-02 15:11:25 -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
build.rs Format code using rust format. 2018-08-03 15:33:34 -04:00
dev.env Fix up configuration of the couchdb database. 2018-07-31 16:41:35 -04:00
docker-compose.yml Add support to add the git revision at build time. 2018-08-02 15:11:25 -04:00
package-lock.json Fix Rust build issue and migrate away from yarn. 2018-07-27 11:29:48 -04:00
package.json Update the package.json and docs in anticipation of the next release of Rookeries. 2018-08-09 11:02:56 -04:00
readme.md Update documentation in README. 2018-08-08 16:42:22 -04:00
webpack.config.babel.js Ensure JS client is built properly. 2018-08-07 14:26:38 -04:00

readme.md

Rookeries

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

Rookeries is:

  • Powered by Rust 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:

  • Rust 1.27+
  • Python 3.6
  • NodeJS 10 + 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.