{"id":22085936,"url":"https://github.com/caleorourke/canary","last_synced_at":"2025-03-23T22:17:12.064Z","repository":{"id":31328337,"uuid":"34890878","full_name":"caleorourke/canary","owner":"caleorourke","description":"A visual mockup to stir talking points around monitoring artifacts.","archived":false,"fork":false,"pushed_at":"2016-03-06T15:28:07.000Z","size":4988,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"gh-pages","last_synced_at":"2025-01-29T05:26:24.737Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://caleorourke.github.io/canary","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caleorourke.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-01T05:25:42.000Z","updated_at":"2016-03-06T15:28:08.000Z","dependencies_parsed_at":"2022-09-09T07:31:38.686Z","dependency_job_id":null,"html_url":"https://github.com/caleorourke/canary","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caleorourke%2Fcanary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caleorourke%2Fcanary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caleorourke%2Fcanary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caleorourke%2Fcanary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caleorourke","download_url":"https://codeload.github.com/caleorourke/canary/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245175484,"owners_count":20572787,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-01T01:17:11.238Z","updated_at":"2025-03-23T22:17:12.042Z","avatar_url":"https://github.com/caleorourke.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"http://travis-ci.org/caleorourke/canary?branch=gh-pages\" target=\"_blank\"\u003e\u003cimg src=\"http://travis-ci.org/caleorourke/canary.svg?branch=gh-pages\" alt=\"Build Status\"\u003e\u003c/a\u003e\n\u003ca href=\"https://david-dm.org/caleorourke/canary#info=devDependencies\" target=\"_blank\"\u003e\u003cimg src=\"https://david-dm.org/caleorourke/canary/dev-status.svg?theme=shields.io\"\u003e\u003c/a\u003e\n\u003ca href=\"http://github.com/caleorourke/canary/blob/gh-pages/LICENSE\" target=\"_blank\"\u003e\u003cimg src=\"http://img.shields.io/badge/License-MIT-blue.svg\" alt=\"MIT-license badge\"\u003e\u003c/a\u003e\n\n## Canary\n\nCanary is a blueprint for defining monitoring data artifacts in a visual manner.\n\n* [Prerequisites](#prerequisites)\n* [Quick Install](#quick-install)\n* [Local Deployment](#local-deployment)\n* [Roll Your Own](#roll-your-own)\n* [Code Organization](#code-organization)\n\n## Prerequisites\n\nCanary 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`.\n\n## Quick Install\n\nClone from GitHub and go into the directory.\n\n```\n$ git clone -b gh-pages https://github.com/caleorourke/canary.git\n$ cd canary\n```\n\nInstall Grunt's CLI.\n\n```\n$ [sudo] npm install -g grunt-cli\n```\n\nInstall Node packages.\n\n```\n$ [sudo] npm install\n```\n\nInstall GitHub Pages and runtime dependencies.\n\n```\n$ [sudo] grunt install\n```\n\n## Local Deployment\n\nRun the command below to preview a local instance of your site.\n\n```bash\n$ grunt serve\n```\n\nAfter Jekyll starts, fire up a browser and type in `localhost:4000` for the web address. This will pull up the site Jekyll just generated.\n\n### Killing Jekyll\n\nServe mode lasts forever. It won't timeout after a period of non-usage. Press `CTRL+C` to stop the service.\n\n## Roll Your Own\n\nMake a fresh clone and go into the directory.\n\n```\n$ git clone https://github.com/username/island.git\n$ cd island\n```\n\nCreate a new `gh-pages` branch.\n\n```\n$ git checkout --orphan gh-pages\n```\n\nCopy the contents from `/canary` to `/island`.\n\n```\n$ [sudo] cp -r ~/canary/* ~/island\n```\n\nPush your site to GitHub.\n\n```\n$ git add .\n$ git commit -a -m \"first commit\"\n$ git push origin gh-pages\n```\n\n## Code Organization\n\nBelow is the basic spread for Canary (not including Jekyll or GitHub-related objects).\n\n\u003cpre\u003e\n├─ _includes/\n│   ├─ charts/\n│   ├─ forms/\n│   ├─ logs/\n│   └─ modals/\n│       ├─ processes/\n│       └─ server/\n├─ _layout/\n├─ js/\n├─ less/\n├─ public/\n│   ├─ css/\n│   ├─ fonts/\n│   ├─ img/\n│   ├─ js/\n│   └─ logs/\n├─ alerts.html\n├─ config.html\n├─ index.html\n├─ logs.html\n├─ processes.html\n├─ profile.html\n├─ settings.html\n├─ support.html\n└─ usage.html\n\u003c/pre\u003e\n\n## License\n\nCode and documentation is licensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaleorourke%2Fcanary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaleorourke%2Fcanary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaleorourke%2Fcanary/lists"}