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,773 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 a63ff2559f tests: Help with test assertions. 2020-01-18 09:35:22 -05:00
.circleci ops: Speed up the CI builds. 2019-12-11 09:46:04 -05:00
docs docs: Update release date for version 0.17.0. 2020-01-17 10:29:37 -05:00
plugins sec: Resolve JS security audit issue. 2019-12-11 09:40:49 -05:00
src cli: Fix tests and the experience of using the tool. 2020-01-15 17:55:27 -05:00
template web: Fix issues with auto-reload. 2019-12-17 09:43:02 -05:00
tests tests: Help with test assertions. 2020-01-18 09:35:22 -05:00
web-app web: Fix issues with auto-reload. 2019-12-17 09:43:02 -05:00
.dockerignore Remove remaining Python dependencies. 2018-08-16 14:53:14 -04:00
.gitignore core: Add support for plugin archive extraction. 2019-09-13 20:05:55 -04:00
Cargo.lock tests: Help with test assertions. 2020-01-18 09:35:22 -05:00
Cargo.toml tests: Help with test assertions. 2020-01-18 09:35:22 -05:00
Dockerfile cli: Fix Dockerized CI builds. 2019-12-04 08:54:51 -05:00
Makefile.toml cli: Fix tests for the initialization of the pages. 2019-10-15 11:51:51 -04:00
build.rs Move generator code up into main part of the project. 2019-07-12 09:18:30 -04:00
readme.md docs: Update the readme. 2019-10-16 13:10:17 -04:00
rookeries-online-installer.sh site: Fix installer. 2019-10-16 22:35:21 -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.
  • Cross-platform for: Linux, Mac OS X/macOS, FreeBSD, and Windows Subsystem for Linux.

Build Status:

  • Built with cargo-make
  • CircleCI: CircleCI

Install

You can install Rookeries by running:

curl https://rookeries.org/downloads/rookeries-online-installer.sh -o rookeries-online-installer.sh
chmod +x rookeries-online-installer.sh
./rookeries-online-installer.sh

Please be sure you have curl, bash, shasum, and sudo installed. You will be able to install newer versions of Rookeries using the installer, so keep it around.

Development

Rookeries uses the following technologies:

  • Rust 2018 (1.36+)
  • Node 10+
  • zip

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 make build-all
  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