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,900 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 402ba834bc build: Pause FreeBSD image building. 2020-07-19 18:52:26 -04:00
.circleci build: Pause FreeBSD image building. 2020-07-19 18:52:26 -04:00
docs docs: Update the changelog. 2020-03-11 23:53:14 -04:00
freebsd-builder ci: Fix setup of clang. 2020-02-24 15:19:43 -05:00
plugins js: Minor audit fix. 2020-03-21 17:12:00 -04:00
src cli: Fix issue with rendering older sites. 2020-03-21 16:46:59 -04:00
template ci: Fix issue with templating index pages. 2020-03-11 23:42:19 -04:00
tests cli: Fix the tests to correspond to the index page. 2020-03-12 00:04:06 -04:00
web-app cli: Update version in preparation for post-0.17.0 work. 2020-01-23 08:27:29 -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: Fix up tests. 2020-02-14 10:46:18 -05:00
Cargo.toml cli: Remove the Debian dependency and add maintenance status. 2020-03-02 10:15:12 -05:00
Dockerfile cli: Fix up issue with the Git revision not added in Docker build. 2020-02-23 12:42:20 -05:00
Makefile.toml js: Fix issues with build by auditing only final JS code. 2020-03-09 17:35:12 -04:00
build.rs Move generator code up into main part of the project. 2019-07-12 09:18:30 -04:00
readme.md ci: Fix issue with docker builds. 2020-02-10 17:53:05 -05:00
rookeries-online-installer.sh cli: Update the installer to use the Linode Object Storage. 2020-02-06 22:26:30 -05: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.40+)
  • 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