https://github.com/caleorourke/canary
A visual mockup to stir talking points around monitoring artifacts.
https://github.com/caleorourke/canary
Last synced: over 1 year ago
JSON representation
A visual mockup to stir talking points around monitoring artifacts.
- Host: GitHub
- URL: https://github.com/caleorourke/canary
- Owner: caleorourke
- License: mit
- Created: 2015-05-01T05:25:42.000Z (about 11 years ago)
- Default Branch: gh-pages
- Last Pushed: 2016-03-06T15:28:07.000Z (over 10 years ago)
- Last Synced: 2025-01-29T05:26:24.737Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://caleorourke.github.io/canary
- Size: 4.76 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Canary
Canary is a blueprint for defining monitoring data artifacts in a visual manner.
* [Prerequisites](#prerequisites)
* [Quick Install](#quick-install)
* [Local Deployment](#local-deployment)
* [Roll Your Own](#roll-your-own)
* [Code Organization](#code-organization)
## Prerequisites
Canary is hosted on GitHub using [GitHub Pages](http://pages.github.com). It can be served locally using [Jekyll](http://jekyllrb.com) with __Ruby 2.0.0__ or greater. [Click here](http://www.ruby-lang.org/en/installation) to download and install Ruby. If you have Ruby, but aren’t sure which version, run `ruby -v`.
## Quick Install
Clone from GitHub and go into the directory.
```
$ git clone -b gh-pages https://github.com/caleorourke/canary.git
$ cd canary
```
Install Grunt's CLI.
```
$ [sudo] npm install -g grunt-cli
```
Install Node packages.
```
$ [sudo] npm install
```
Install GitHub Pages and runtime dependencies.
```
$ [sudo] grunt install
```
## Local Deployment
Run the command below to preview a local instance of your site.
```bash
$ grunt serve
```
After Jekyll starts, fire up a browser and type in `localhost:4000` for the web address. This will pull up the site Jekyll just generated.
### Killing Jekyll
Serve mode lasts forever. It won't timeout after a period of non-usage. Press `CTRL+C` to stop the service.
## Roll Your Own
Make a fresh clone and go into the directory.
```
$ git clone https://github.com/username/island.git
$ cd island
```
Create a new `gh-pages` branch.
```
$ git checkout --orphan gh-pages
```
Copy the contents from `/canary` to `/island`.
```
$ [sudo] cp -r ~/canary/* ~/island
```
Push your site to GitHub.
```
$ git add .
$ git commit -a -m "first commit"
$ git push origin gh-pages
```
## Code Organization
Below is the basic spread for Canary (not including Jekyll or GitHub-related objects).
├─ _includes/
│ ├─ charts/
│ ├─ forms/
│ ├─ logs/
│ └─ modals/
│ ├─ processes/
│ └─ server/
├─ _layout/
├─ js/
├─ less/
├─ public/
│ ├─ css/
│ ├─ fonts/
│ ├─ img/
│ ├─ js/
│ └─ logs/
├─ alerts.html
├─ config.html
├─ index.html
├─ logs.html
├─ processes.html
├─ profile.html
├─ settings.html
├─ support.html
└─ usage.html
## License
Code and documentation is licensed under the MIT license.