In french / en français : readme-fr.md

Upscuits

Short for crispy uptime-biscuits

With Upscuits you have a nice overview of the uptime of your servers, and a page to share with your customers.

Tools needed:

A webserver capable of serving static files
A free account at Uptime Robot
A oven or text-editor

Preparations:

You can skip step 1 and 2 if you've already got a monitor at Uptime Robot

Login at Uptime Robot.
Add a new monitor
Go to MySettings ("Monitor-Specific API Keys" at bottom right) and create/write down the API key for the monitor.

Directions:

Clone or copy all files in public to your disk
Copy public/js/config.example.js to public/js/config.js
Paste one ore more API keys as an array in config.js
Upload public to your webserver/ shared hosting, or host on Heroku as explained below:

Deploying on Heroku:

Install the Heroku Toolbelt to start, then follow their 'Getting Started' instructions, including logging in:

$ heroku login
Enter your Heroku credentials.
Email: youremail@example.com
Password (typing will be hidden): 
Authentication successful.

Make sure you've created a git repository, and that your work is committed.

Next, create a Heroku app:

$ heroku create myapp --buildpack https://github.com/heroku/heroku-buildpack-nodejs.git
Creating myapp... done, stack is cedar
BUILDPACK_URL=https://github.com/heroku/heroku-buildpack-nodejs.git
http://myapp.herokuapp.com/ | git@heroku.com:myapp.git

Now you're ready to deploy to Heroku:

$ git push heroku yourbranch:master

If you get an permission denied-error, run $ heroku keys:add ~/.ssh/id_rsa.pub to copy your ssh key to Heroku.

If you make any changes to your app, just commit and push them as before:

$ git commit -am "Awesome crazy update"
$ git push heroku yourbranch:master

Your own flavor:

This project uses Grunt. You could edit the files in the public folder, but is advised to use Grunt to build the files in public-folder. Install Grunt with:

$ npm install -g grunt-cli

Next, install the required grunt plugins from packages.json by running:

$ npm install

Now modify the code in the folder source as it pleases you. While editing you can use this to build everytime you save a file:

$ grunt watch

To serve the public-folder on http://localhost:8000 run:

$ grunt connect watch

To only compile the less files, use grunt css, or to concat javascript files use grunt js. To make a new release, run:

grunt

Testing

For testing we use Mocha - the fun, simple, flexible JavaScript test framework. Specs are written in test/spec/test.js

Before runing tests, run bower - A package manager for the web to install Mocha and his friends:

$ cd test
$ bower install

Now you can run the tests with:

$ grunt test

To run the tests in a browser:

$ grunt connect:test:keepalive

To just serve the public folder on localhost:3000

$ node app.js

Ingredients:

Cake:
- Bootstrap (2 lbs)
- UptimeRobot (6 oz.)
- i18n (1 cup per language)
- Express (just for your own flavor)
Topping:
- Gauge.js (4 cups per server)
- Font Awesome (1/2 teaspoon)
- {{Mustaches}} (1/3 lbs)

License:

This work is licensed under GPL-v3 license

zeanzhou/upscuits