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,716 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 e836e92b49 cli: Add test for creating a site. 2019-10-15 08:58:11 -04:00
.circleci test: Ensure Rust dependencies audited. 2019-10-03 09:49:12 -04:00
docs core: Update the changelog. 2019-10-02 17:59:48 -04:00
plugins security: Fix CI issues with npm audit setup. 2019-10-03 11:19:46 -04:00
src cli: Refactor to make tests better. 2019-10-07 08:45:24 -04:00
template template: Update the initial site template. 2019-08-23 15:48:24 -04:00
tests cli: Add test for creating a site. 2019-10-15 08:58:11 -04:00
web-app security: Ensure npm dependencies audited. 2019-10-03 09:57:32 -04: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 test: Ensure Rust dependencies audited. 2019-10-03 09:49:12 -04:00
Cargo.toml core: Resolve issue with linking under OS X. 2019-09-17 17:31:09 -04:00
Dockerfile core: Fix issues with Docker setup. 2019-10-03 10:24:51 -04:00
Makefile.toml security: Fix CI issues with npm audit setup. 2019-10-03 11:19:46 -04:00
build.rs Move generator code up into main part of the project. 2019-07-12 09:18:30 -04:00
readme.md core: Update the installer. 2019-10-01 12:17:08 -04:00
rookeries-online-installer.sh core: Fix the installer paths. 2019-10-01 13:31:44 -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.

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