Demonstration release of the principles underpinning krsd.
[krsd] / demo / todo / readme.md
1 # ![TodoMVC](https://raw.github.com/tastejs/todomvc/gh-pages/media/logo.png)
2
3 ## Helping you select an MV\* framework
4
5
6 Developers these days are spoiled with choice when it comes to selecting an MV\* framework for structuring and organizing JavaScript web apps.
7
8 Backbone, Ember, AngularJS, Spine... the list of new and stable solutions goes on and on, but just how do you decide on which to use in a sea of so many options?
9
10 To help solve this problem, we created TodoMVC - a project which offers the same Todo application implemented using MV* concepts in most of the popular JavaScript MV\* frameworks of today.
11
12
13 #### Todo apps are included for:
14
15 - [Backbone.js](http://documentcloud.github.com/backbone)
16 - [Ember.js](http://emberjs.com)
17 - [AngularJS](http://angularjs.org)
18 - [Spine](http://spinejs.com)
19 - [KnockoutJS](http://knockoutjs.com) (MVVM)
20 - [Dojo](http://dojotoolkit.org)
21 - [YUI](http://yuilibrary.com)
22 - [Batman.js](http://batmanjs.org)
23 - [Closure](http://code.google.com/closure/library/)
24 - [Agility.js](http://agilityjs.com)
25 - [Knockback.js](http://kmalakoff.github.com/knockback)
26 - [Google Web Toolkit](https://developers.google.com/web-toolkit/)
27 - [Flight by Twitter](https://github.com/twitter/flight)
28
29
30 ###### Non-framework Implementations
31
32 - [jQuery](http://jquery.com)
33 - [Vanilla JS](http://todomvc.com/vanilla-examples/vanillajs/)
34
35 ###### RequireJS
36
37 - [Backbone.js](http://documentcloud.github.com/backbone) + [RequireJS](http://requirejs.org)
38 - [AngularJS](http://angularjs.org) + [RequireJS](http://requirejs.org)
39 - [KnockoutJS](http://knockoutjs.com) + [RequireJS](http://requirejs.org)
40 - [CanJS](http://canjs.us) + [RequireJS](http://requirejs.org)
41
42 #### Labs
43
44 We also have a number of in-progress applications in Labs:
45
46 - [Ractive](http://ractivejs.org)
47 - [React](http://facebook.github.io/react)
48 - [Meteor](http://meteor.com)
49 - [Derby](http://derbyjs.com)
50 - [CanJS](http://canjs.us)
51 - [Kendo UI](http://kendoui.com)
52 - [Maria.js](https://github.com/petermichaux/maria)
53 - [cujoJS](http://cujojs.com)
54 - [MarionetteJS](http://marionettejs.com/)
55 - [SocketStream](http://www.socketstream.org) + [jQuery](http://jquery.com)
56 - [Ext.js](http://www.sencha.com/products/extjs)
57 - [Sammy.js](http://sammyjs.org)
58 - [dermis](https://github.com/wearefractal/dermis)
59 - [Stapes.js](http://hay.github.com/stapes)
60 - [Epitome](http://dimitarchristoff.github.com/Epitome)
61 - [TroopJS](https://github.com/troopjs)
62 - [soma.js](http://somajs.github.com/somajs)
63 - [DUEL](https://bitbucket.org/mckamey/duel/wiki/Home)
64 - [Olives](https://github.com/flams/olives)
65 - [PlastronJS](https://github.com/rhysbrettbowen/PlastronJS)
66 - [Dijon](https://github.com/creynders/dijon-framework)
67 - [rAppid.js](http://www.rappidjs.com)
68 - [Thorax](http://walmartlabs.github.com/thorax/)
69 - [KnockoutJS](http://knockoutjs.com) + [ClassBindingProvider](https://github.com/rniemeyer/knockout-classBindingProvider) (using Ryan Niemeyer's Class Binding Provider)
70 - [KnockoutJS](http://knockoutjs.com) + [RequireJS](http://requirejs.org) (using AMD)
71 - [AngularJS](http://angularjs.org) + [RequireJS](http://requirejs.org) (using AMD)
72 - [CanJS](http://canjs.us) + [RequireJS](http://requirejs.org) (using AMD)
73 - [AngularJS](http://angularjs.org) (optimized)
74 - [Backbone.xmpp](https://github.com/ggozad/Backbone.xmpp)
75 - [Dart](http://dartlang.org)
76 - [Chaplin](http://chaplinjs.org) + [Brunch](http://brunch.io)
77 - [Serenade.js](https://github.com/elabs/serenade.js)
78 - [TypeScript](http://www.typescriptlang.org/)
79 - [DeftJS](http://deftjs.org/)
80 - [Aria Templates](http://ariatemplates.com/)
81 - [Enyo + Backbone.js](http://enyojs.com/)
82 - [SAPUI5](http://scn.sap.com/community/developer-center/front-end)
83 - [Lavaca](http://getlavaca.com) + [RequireJS](http://requirejs.org) (using AMD)
84 - [ComponentJS](http://componentjs.com)
85
86 ## Live demos
87
88 Live demos are available on our [website](http://todomvc.com)
89
90 ## View & Run in Web IDE
91
92 Click on the button below to view the code in a Web IDE. Feel free to edit the code and then run it all from your browser.
93
94 [![IDE](https://raw.github.com/tastejs/todomvc/gh-pages/site-assets/editcloud9.png)](https://c9.io/open/git/?url=git://github.com/tastejs/todomvc.git)
95 [![IDE](https://codio-public.s3.amazonaws.com/sharing/demo-in-ide.png)](https://codio.com/p/create/?from_github=tastejs/todomvc)
96
97
98 ## Screenshot
99
100 ![screenshot](https://raw.github.com/tastejs/todomvc/gh-pages/site-assets/screenshot.png)
101
102
103 ## Team
104
105 TodoMVC would not be possible without a strong team of [contributors](https://github.com/tastejs/todomvc/contributors) helping push the project forward each day. In addition, we have a core project team composed of:
106
107 #### [Addy Osmani](http://github.com/addyosmani) - Founder/Lead
108
109 <img align="left" width="40" height="40" src="http://www.gravatar.com/avatar/96270e4c3e5e9806cf7245475c00b275.png?s=40">
110 Addy is a Developer Platform Engineer at Google who originally created TodoMVC. He oversees the project direction, drives expansion and helps lead core development with Sindre Sorhus (by far our most active contributor!).
111
112 #### [Sindre Sorhus](https://github.com/sindresorhus) - Lead Developer
113
114 <img align="left" width="40" height="40" src="http://www.gravatar.com/avatar/d36a92237c75c5337c17b60d90686bf9.png?s=40">
115 Sindre is a Web Developer who drives core development, quality control and application design for the project. His contributions have helped us ensure consistency and best practices are enforced wherever possible.
116
117 #### [Pascal Hartig](https://github.com/passy) - Developer
118
119 <img align="left" width="40" height="40" src="http://www.gravatar.com/avatar/be451fcdbf0e5ff07f23ed16cb5c90a3.png?s=40">
120 Pascal is a Front-end Engineer at Twitter with a deep passion for consistency. He watches pull requests and helps developers getting their contributions integrated with TodoMVC.
121
122 #### [Stephen Sawchuk](https://github.com/stephenplusplus) - Developer
123
124 <img align="left" width="40" height="40" src="https://secure.gravatar.com/avatar/098cfe2d360e77c3229f2cd5298354c4?s=40">
125 Stephen is a Front-end Engineer at Quicken Loans that cares about improving the maintainability and developer experience of open-source projects. His recent contributions include helping us move all apps over to using Bower and implementing the new information bar.
126
127 #### [Colin Eberhardt](https://github.com/colineberhardt) - Developer
128
129 <img align="left" width="40" height="40" src="https://secure.gravatar.com/avatar/73bba00b41ff1c9ecc3ee29487bace7d?s=40">
130 Colin is a software consultant at Scott Logic who is passionate about all software - from JavaScript to Java, and C# to Objective-C. His recent contribution to the project has been a fully automated test suite.
131
132 #### [Gianni Chiappetta](https://github.com/gf3) - Logo designer
133
134 <img align="left" width="40" height="40" src="http://www.gravatar.com/avatar/4b0209ae3652cc5a7d53545e759fbe39.png?s=40">
135 Gianni is a programmer and designer currently working as the Chief Rigger at MetaLab.
136
137 ## Disclaimer
138
139 <img align="right" width="230" height="230" src="https://raw.github.com/tastejs/todomvc/gh-pages/media/icon-small.png">
140
141 TodoMVC has been called many things including the 'Speed-dating' and 'Rosetta Stone' of MV* frameworks. Whilst we hope that this project is able to offer assistance in deciding what frameworks are worth spending more time looking at, remember that the Todo application offers a limited view of what a framework may be capable of.
142
143 It is meant to be used as a gateway to reviewing how a basic application using a framework may be structured and we heavily recommend investing time researching a solution in more depth before opting to use it.
144
145
146 ## Getting Involved
147
148 Whilst we enjoy implementing and improving existing Todo apps, we're always interested in speaking to framework authors (and users) wishing to share Todo app implementations in their framework/solution of choice.
149
150 Check out our [contribution docs](contributing.md) for more info.
151
152
153 ## License
154
155 Everything in this repo is MIT License unless otherwise specified.
156
157 MIT © Addy Osmani, Sindre Sorhus, Pascal Hartig, Stephen Sawchuk.