2015-09-03 13:31:52 -04:00
|
|
|
# Rookeries
|
|
|
|
|
|
|
|
|
|
**Rookeries** is:
|
2019-07-19 08:56:22 -04:00
|
|
|
|
|
|
|
|
- A developer and designer friendly static site generator for building gorgeous,
|
|
|
|
|
maintainable and extendable websites, that embraces the future of the web.
|
2019-07-23 08:59:40 -04:00
|
|
|
- Powered by Rust and Web Components.
|
2019-07-19 08:56:22 -04:00
|
|
|
- Licensed under the Apache 2.0 license.
|
2019-10-01 12:17:08 -04:00
|
|
|
- Cross-platform for: Linux, Mac OS X/macOS, FreeBSD, and Windows Subsystem for Linux.
|
2015-09-03 13:31:52 -04:00
|
|
|
|
2016-10-25 17:47:05 -04:00
|
|
|
## Build Status:
|
2015-09-03 13:31:52 -04:00
|
|
|
|
2018-09-28 14:31:21 -04:00
|
|
|
- [](https://sagiegurari.github.io/cargo-make)
|
2016-12-16 23:13:53 -05:00
|
|
|
- **CircleCI**: [](https://circleci.com/bb/dorianpula/rookeries "CircleCI builds")
|
2016-04-09 08:55:14 -04:00
|
|
|
|
2019-09-29 17:16:24 -04:00
|
|
|
## Install
|
|
|
|
|
|
|
|
|
|
You can install Rookeries by running:
|
|
|
|
|
|
2019-10-01 12:17:08 -04:00
|
|
|
```bash
|
|
|
|
|
curl https://rookeries.org/downloads/rookeries-online-installer.sh -o rookeries-online-installer.sh
|
|
|
|
|
chmod +x rookeries-online-installer.sh
|
|
|
|
|
./rookeries-online-installer.sh
|
|
|
|
|
```
|
2019-09-29 17:16:24 -04:00
|
|
|
|
2019-10-16 13:10:17 -04:00
|
|
|
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.
|
2016-04-09 08:55:14 -04:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
*Rookeries* uses the following technologies:
|
|
|
|
|
|
2020-02-10 17:53:05 -05:00
|
|
|
- Rust 2018 (1.40+)
|
2019-09-27 11:14:47 -04:00
|
|
|
- Node 10+
|
|
|
|
|
- zip
|
2019-07-19 08:56:22 -04:00
|
|
|
|
|
|
|
|
Note that *Rookeries* is heavily under active development and may undergo
|
|
|
|
|
significant changes before its 1.0.0 release.
|
2016-04-09 08:55:14 -04:00
|
|
|
|
|
|
|
|
### Getting Started
|
|
|
|
|
|
2019-07-19 08:56:22 -04:00
|
|
|
1. Clone the repository.
|
2019-04-23 08:56:15 -04:00
|
|
|
1. Install [cargo-make](https://sagiegurari.github.io/cargo-make): `cargo install --force cargo-make`
|
2019-09-29 17:16:24 -04:00
|
|
|
1. Build Rookeries: `cargo make build-all`
|
2019-06-13 08:12:06 -04:00
|
|
|
1. Run UI tests: `cargo make test-app`
|
2019-07-12 09:18:30 -04:00
|
|
|
1. Run tests: `cargo make test`
|
2019-07-12 17:40:56 -04:00
|
|
|
1. Create and run the sample site:
|
|
|
|
|
1. `cargo make init-sample-site`
|
|
|
|
|
1. `cargo make build-sample-site`
|
|
|
|
|
1. `cargo make serve-sample-site`
|
