Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Arush Sehgal committed Oct 11, 2013
1 parent 4b3efc5 commit 926cbc4
Showing 1 changed file with 48 additions and 6 deletions.
54 changes: 48 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# A boilerplate for AngularJS x Backbone.js x Parse apps
# A Quickstart Boilerplate for Big AngularJS x Parse apps


An opinionated, battle-tested boilerplate for building large, powerful, serverless apps with AngularJS, Backbone and Parse.
Expand All @@ -17,24 +17,66 @@ Built by guys who would rather be coding than [shopping](http://www.getbrandid.c

### Why we made this

Thanks to [Mahmoud](https://twitter.com/mahmoudimus) from [Balanced](https://github.com/balanced) for the inspiration to be more open.

We love [Parse](http://parse.com), Backbone.js and AngularJS. We hate servers.
-------

Whilst building [BRANDiD](http://www.getbrandid.com) we developed some best practices around this stack, so we decided to open source it here. We even talked about it on the [Parse Blog](http://blog.parse.com).
We love [Parse](http://parse.com) and AngularJS. We hate servers. Whilst building [BRANDiD](http://www.getbrandid.com) we developed some best practices around this stack, so we decided to open source it here. We even talked about it on the [Parse Blog](http://blog.parse.com).

This boilerplate is great for launching complex database enabled apps really fast. Let us know what we can improve via twitter [@spacenick](http://www.twitter.com/spacenick) and [@arush](http://www.twitter.com/arush)!
This boilerplate is a quickstart for large, maintainable, database enabled AngularJS apps. Let us know what we can improve via twitter [@spacenick](http://www.twitter.com/spacenick) and [@arush](http://www.twitter.com/arush)!

------

### Get Started
##### node v0.10.x, grunt v0.4.x

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

------
### Performance
[BRANDiD](https://www.getbrandid.com/) regularly gets over 100 concurrent connections, and we have no issues at all with this setup.

------

### Credits

[ericlemmons/genesis-skeleton](https://github.com/ericclemmons/genesis-skeleton) - server boilerplate

[daneden/animate.css](https://github.com/daneden/animate.css) - animations

[Bootstrap CDN](http://www.bootstrapcdn.com/) - Bootstrap hosting

------

### Contribute

* Tests (help!?)
* 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)
* 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 a simple alternative to [AngularFire](www.angularfire.com)

------

### License
parse-angular-demo is licensed under the ☺ license. (http://licence.visualidiot.com/)


------

### Got ideas?
### If you found this useful


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

Next time you think of clothes, think BRANDiD - Shop. Like a Man.



* A dedicated expert shopper searches the ends of the earth just for you
* Try clothes from any ecommerce store in the world before you buy them, no commitment
* We ship and collect returns for free even if the retailer doesn't

Send us a pull request!

0 comments on commit 926cbc4

Please sign in to comment.