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,762 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 33d1ed2853 web: Add support for checking for updated content hashes in dev-mode. 2019-12-16 17:53:10 -05:00
.circleci ops: Speed up the CI builds. 2019-12-11 09:46:04 -05:00
docs docs: Add note to changelog about multi-file template support. 2019-12-10 09:03:45 -05:00
plugins sec: Resolve JS security audit issue. 2019-12-11 09:40:49 -05:00
src cli: Add notes on further development of Rookeries. 2019-12-16 08:53:03 -05:00
template cli: Ensure the template forces no-caching. 2019-12-16 08:39:05 -05:00
tests Merged in template-engine-refactor (pull request #34) 2019-12-10 14:01:23 +00:00
web-app web: Add support for checking for updated content hashes in dev-mode. 2019-12-16 17:53:10 -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 cli: Experimental setup for file watching. 2019-12-09 17:59:25 -05:00
Cargo.toml cli: Add notes on resolving issue with a dependency. 2019-12-10 08:39:09 -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