A developer and designer friendly web platform for building gorgeous sites, blogs and portfolios.
Go to file
Dorian 35bab4d518 Fix the CI test failures due to path changes. 2019-07-26 09:56:58 -04:00
.circleci Resolve move CI name mismatch issues. 2019-07-12 17:50:10 -04:00
docs Work to get back into npm based web component plugins. 2019-07-23 08:59:40 -04:00
plugins Update chromium karma launcher to have no sandbox option. 2019-07-25 16:41:45 -04:00
src Get configurable header and footer into single location. 2019-07-25 17:40:26 -04:00
templates Move generator code up into main part of the project. 2019-07-12 09:18:30 -04:00
web-app Fix the CI test failures due to path changes. 2019-07-26 09:56:58 -04:00
.dockerignore Remove remaining Python dependencies. 2018-08-16 14:53:14 -04:00
.gitignore Ensure being able to use a project directory. 2019-07-09 08:50:24 -04:00
Cargo.lock Add ability to serve files for a pre-built project. 2019-07-15 09:56:37 -04:00
Cargo.toml Clean up the documentation in preparation for release. 2019-07-19 08:56:22 -04:00
Dockerfile Remove Firefox from the CI for now. 2019-07-25 15:18:48 -04:00
Makefile.toml Remove unused plugins. 2019-07-19 09:03:57 -04:00
build.rs Move generator code up into main part of the project. 2019-07-12 09:18:30 -04:00
docker-compose.yml Resolve move CI name mismatch issues. 2019-07-12 17:50:10 -04:00
readme.md Work to get back into npm based web component plugins. 2019-07-23 08:59:40 -04:00

readme.md

Rookeries

Rookeries is:

  • A developer and designer friendly static site generator for building gorgeous, maintainable and extendable websites, that embraces the future of the web.
  • Powered by Rust and Web Components.
  • Licensed under the Apache 2.0 license.

Build Status:

  • Built with cargo-make
  • CircleCI: CircleCI

Development

Rookeries uses the following technologies:

  • Rust 2018 (1.36+)
  • Node 10.x

Note that Rookeries is heavily under active development and may undergo significant changes before its 1.0.0 release.

Getting Started

  1. Clone the repository.
  2. Install cargo-make: cargo install --force cargo-make
  3. Build Rookeries: cargo build
  4. Run UI tests: cargo make test-app
  5. Run tests: cargo make test
  6. Create and run the sample site:
    1. cargo make init-sample-site
    2. cargo make build-sample-site
    3. cargo make serve-sample-site