From b6af6b17c30d70c4fa8c257341e890ab9d0bfc51 Mon Sep 17 00:00:00 2001 From: yeouchien Date: Mon, 21 Mar 2016 07:42:41 +0000 Subject: [PATCH] Add nitrous.io Quickstart and update README --- README.md | 11 +++++++++++ README.nitrous.md | 13 +++++++++++++ nitrous.json | 11 +++++++++++ 3 files changed, 35 insertions(+) create mode 100644 README.nitrous.md create mode 100644 nitrous.json diff --git a/README.md b/README.md index fd50c778..2759a26d 100644 --- a/README.md +++ b/README.md @@ -7,5 +7,16 @@ Dashing is a Sinatra based framework that lets you build beautiful dashboards. I Note: Dashing is no longer being actively maintained. Read about it [here](https://github.com/Shopify/dashing/issues/711). + +# Nitrous Quickstart +You can quickly create a free development environment for this Dashing project in the cloud on www.nitrous.io: + + + Nitrous Quickstart + + +In the IDE, start Dashing via `Run > Start Dashing` and access your site via `Preview > 3030`. + + # License Distributed under the [MIT license](MIT-LICENSE) diff --git a/README.nitrous.md b/README.nitrous.md new file mode 100644 index 00000000..a4a27f31 --- /dev/null +++ b/README.nitrous.md @@ -0,0 +1,13 @@ +# Setup + +Welcome to your Dashing project on Nitrous. + +## Running the development server: + +In the [Nitrous IDE](https://community.nitrous.io/docs/ide-overview), start dashing via "Run > Start Dashing". + +Now you've got a development server running and can see the output in the Nitrous terminal window. You can open up a new shell or utilize [tmux](https://community.nitrous.io/docs/tmux) to open new shells to run other commands. + +## Preview the app + +In the Nitrous IDE, open the "Preview" menu and click "Port 3030". diff --git a/nitrous.json b/nitrous.json new file mode 100644 index 00000000..cf5a0a16 --- /dev/null +++ b/nitrous.json @@ -0,0 +1,11 @@ +{ + "template": "ruby", + "ports": [3030], + "name": "Dashing", + "description": "Dashing is a Sinatra based framework that lets you build beautiful dashboards. It looks especially great on TVs.", + "no_clone": true, + "scripts": { + "post-create": "cd /home/nitrous/code && gem install dashing && dashing new sweet_dashboard_project && cd sweet_dashboard_project && bundle", + "Start Dashing": "cd ~/code/sweet_dashboard_project && dashing start" + } +}