A developer and designer friendly web platform for building gorgeous sites, blogs and portfolios.
Go to file
Dorian 4e9f5eabb2 Create a debian package to distribute. 2019-08-09 21:11:18 -04:00
.circleci Resolve move CI name mismatch issues. 2019-07-12 17:50:10 -04:00
docs Temporarily resolve the issue of not supporting configurable landing pages. 2019-08-08 08:42:32 -04:00
plugins Add a way to build and prepare JS assets. 2019-08-07 20:40:01 -04:00
src Implement handling of creating a new project. 2019-08-09 10:15:49 -04:00
template Improve template setup. 2019-08-07 21:06:55 -04:00
web-app Fix up plugins with latest setup. 2019-08-07 08:41:47 -04:00
.dockerignore Remove remaining Python dependencies. 2018-08-16 14:53:14 -04:00
.gitignore Improve template setup. 2019-08-07 21:06:55 -04:00
Cargo.lock Add ability to serve files for a pre-built project. 2019-07-15 09:56:37 -04:00
Cargo.toml Create a debian package to distribute. 2019-08-09 21:11:18 -04:00
Dockerfile Fix the builds due to template directory rename. 2019-08-08 08:16:07 -04:00
Makefile.toml Implement the site init functionality. 2019-08-09 08:55:16 -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