Skip to content

Commit

Permalink
improved installation instructions for n00bs
Browse files Browse the repository at this point in the history
  • Loading branch information
Arush Sehgal committed Oct 17, 2013
1 parent dc8c4f2 commit 6f7673e
Showing 1 changed file with 34 additions and 10 deletions.
44 changes: 34 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

An opinionated, battle-tested boilerplate for building large, powerful, serverless apps with AngularJS and Parse.



Built by guys who would rather be coding than [shopping](http://www.getbrandid.com)

------
Expand All @@ -13,6 +15,17 @@ Built by guys who would rather be coding than [shopping](http://www.getbrandid.c
<http://brandid.github.io/parse-angular-demo>


------
### Who is this for?
Maybe you're already using Parse for mobile and you need a web presence now too.

Maybe you’re an AngularJS beginner and you want to learn how big AngularJS apps are built.

Maybe you're already familiar with AngularJS or Backbone and you need a solid architecture that will scale nicely as your app scales.

Maybe you're at a hackathon, and you need to quickly launch a dynamic web app that requires user sessions and data storage.


------

### Why we made this
Expand All @@ -37,19 +50,27 @@ This boilerplate is a quickstart for large, maintainable, database enabled Angul
* Easy Animations on State Change
* Enhanced Load Performance of the Parse and Facebook SDKs
* Data Modules for Parse Models and Collections
* [Genesis-Skeleton](https://github.com/ericclemmons/genesis-skeleton) node / grunt setup for local development
* …and lots more

Read about all the features [here](http://brandid.github.io/parse-angular-demo/#/features)

------

### Get Started
##### node v0.10.x, grunt v0.4.x
##### You will need bower installed as well (npm install -g bower)

git clone [email protected]:brandid/parse-angular-demo.git
npm install
grunt server
### Installation Instructions

1. Install node - http://nodejs.org/
1. Install grunt v0.4.x - http://gruntjs.com/getting-started
1. Install bower `npm install -g bower`
1. Clone this repo `git clone [email protected]:brandid/parse-angular-demo.git`
1. Switch out your Parse keys in **ParseServices.js** (see below)
1. Remove our [GoSquared](www.gosquared.com) tracking snippet from **index.html**
1. `cd parse-angular-demo`
1. `npm install`
1. `bower install`
1. `grunt server` - builds and fires up the local node server on localhost:3000
1. Visit http://localhost.com:3000 to develop your site
1. `grunt build` to build a deployable version in the parse-angular-demo/build folder

------
### Wire up your own Parse backend in seconds
Expand Down Expand Up @@ -79,10 +100,13 @@ Read about all the features [here](http://brandid.github.io/parse-angular-demo/#

### Contribute

* Angular Backbone bindings for easier forms with Parse SDK (60% complete - @spacenick)
* Better documentation/video on how to customise queries like ParseQueryTableViewController
* Convert to [grunt-takana](https://github.com/mechio/grunt-takana) instead of grunt-contrib-compass (too slow)
* Tests (help!?)
* Tests (help!)
* Upgrade to Bootstrap 3.0.x
* Guidance on User object creation / ACL to protect against [this](https://www.webniraj.com/2013/08/01/using-the-parse-javascript-sdk-be-careful/) Parse API design decision. For those who need to retrospectively protect their database, read [this thread](https://www.parse.com/questions/cant-update-user-acl-on-the-dashboard-cloud-code-w-master-key)
* Docs and examples on User session handling
* Docs and examples on ACL to protect against [this](https://www.webniraj.com/2013/08/01/using-the-parse-javascript-sdk-be-careful/) Parse API design decision. For those who need to retrospectively protect their database, read [this thread](https://www.parse.com/questions/cant-update-user-acl-on-the-dashboard-cloud-code-w-master-key)
* Open source the BRANDiD [Customer.io](www.customer.io) Cloud Code module to securely trigger transactional emails with unlimited custom data (You cannot send large payloads with the Customer.io JS SDK)
* Include [AngularFirebasePatch](https://github.com/spacenick/angular-firebase-patch) for real-time support, which is our simple alternative to [AngularFire](www.angularfire.com)

Expand All @@ -99,7 +123,7 @@ parse-angular-demo is licensed under the &#9786; license. (http://licence.visual

![BRANDiD](https://d2asqqdjv2zbgw.cloudfront.net/logos/header-logo.png)

Next time you think of clothes, think BRANDiD - Shop. Like a Man.
Next time you think of clothes, think [BRANDiD - Shop. Like a Man](https://www.getbrandid.com).



Expand Down

0 comments on commit 6f7673e

Please sign in to comment.