Skip to content

Commit

Permalink
updating the README with the exact steps that one needs to perform in…
Browse files Browse the repository at this point in the history 
… order to gain a running instance of freeboard once cloning the repository
  • Loading branch information
@lirantal
lirantal committed Jun 28, 2015
1 parent cabdf90 commit ef84070
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
View file
Expand Up @@ -25,6 +25,12 @@ The code here is the client-side portion of what you see when you visit a freebo

Freeboard can be run entirely from a local hard drive. Simply download/clone the repository and open index.html. When using Chrome, you may run into issues with CORS when accessing JSON based APIs if you load from your local hard-drive— in this case you can switch to using JSONP or load index.html and run from a local or remote web server.

1. git clone https://github.com/Freeboard/freeboard.git
2. npm install
3. grunt

Then run a index.html or index-dev.html through a webserver.

### API

While freeboard runs as a stand-alone app out of the box, you can augment and control it from javascript with a simple API. All API calls are made on the `freeboard` singleton object.
Expand Down

1 comment on commit ef84070

@ssvegeta96
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noob Here

In case more noobs get to this to get freebaord running
These are the things I had to do for progress on this

1. install ( apt-get install git-core -y )
2. install nodejs ( curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash - )
3. install grunt ( npm install -g grunt-cli )
3. install nodejs ( sudo apt-get nodejs -y)

THEN
I can run the commands that are stated above

Please sign in to comment.