Home

SproutCore is an MVC web app framework for developing apps in JavaScript that run inside a web browser.

Welcome to the SproutCore Community Wiki

Please help keep this wiki useful and current by adding your own pages or editing existing pages (see Wiki Editing Guidelines for more info). Thanks! – The SproutCore Team

Quick Links

• What is SproutCore? Read me first.
• How do I get SproutCore? Beginner-friendly installation instructions.
• What server does SproutCore run on? (e.g. Rails, Zope, WebObjects) Short answer: all of them, none of them.
• Sproutcore Updates and Versions How to update and list of versions.

Tutorials and Howtos

Step-by-step guides to performing various tasks in SproutCore. If you don’t see a guide here that you think should exist, add one!

Introductory

• SproutCore Hello World – A quick, basic hands-on tutorial on getting started with SproutCore.
• SproutCore 5 Minute Tutorial – If you are new to SproutCore and want to take it out for a test drive, take the 5-minute tour to see how fast it is to build a great web app using SproutCore.
• SproutCore’s Modern Model Layer – Also covers key-value coding and key-value observing.
• SproutCore’s Modern Model Layer: Part 2 – SC.Store, plus how to use collections and collections controllers.
• SproutCore’s Modern Model Layer: Part 3 – The object graph, fixtures, and to-one and to-many relationships.
• Keeping Control – SproutCores various Controller classes and how they differ.
• Unit Testing – Discover the basics of Unit Testing in SproutCore
• Doc Tool – How to use the SproutCore Doc Tool to document your own application code.
• IE7 Debugging Tips – How to debug SproutCore in IE 7.

Intermediate

• Using the built-in REST API – How to use the API with a server backend.
• Changing your application build root – How to change your application root from ”/static”.
• Software Updates for SproutCore Applications – Just like desktop apps, only better.
• Name Based Virtual Hosting with Apache and the Proxy Setting in the sc-config file – How to set up Name Based Virtual Hosting with Apache and use the Proxy setting in the sc-config file.
• Changing your application’s title – How to change your application’s title.
• Using autocomplete from script.aculo.us with sproutcore – playing with script.aculo.us in sproutcore
• Creating Custom Views – How to create simple custom views
• Many-to-Many Relationship: Relationship Object Method – Many-to-Many Relationships Tutorial
• Computed Property Code Dissection – The ins-and-outs of using computed properties in the model: a case study.

Server-side frameworks

• Setting up SproutCore with a PHP backend – How to set up SproutCore with a PHP backend.
• Setting Up ASP.Net 3.5 and Sproutcore – Use Web Services to send and receive JSON formatted objects.
• Using SproutCore to Build OpenSocial Applications Step by Step – This step by step guide first shows you how to build a (very) poor man’s photos application and then goes on to explain how to turn it into an OpenSocial gadget that can run on MySpace, Orkut, you name it.
• Using Sproutcore with Ruby on Rails: Part I – Learn how to get information from Rails and display it in a Sproutcore application.
• Using Sproutcore with Ruby on Rails: Part II – This time around you will learn how to use all the basic CRUD operations.
• Sproutcore, REST and WCF Web Services – A .Net WCF implementation of the sproutcore Using the built-in REST API sample.
• Using with CouchDB – How to get SproutCore talking directly with a CouchDB backend.
• Using Sproutcore with django – A short tutorial on the google code project page of the django-sproutcore project.

Sproutcore Development

• Hacking SproutCore – Improve SproutCore and submit your changes back to the community.
• Embedding Sproutcore as a Submodule in Your Application – Git Sproutcore Help

Other languages

• 1, 2, 3… Aprendendo a caminhar com SproutCore – Portuguese
• SproutCore Wiki Japanese Translation –Translation from this wiki page to Japanese

Topics

In-depth explanation of SproutCore topics. Unlike tutorials, this section is not for step-by-step guides but for in-depth articles on issues. If you don’t see a topic covered here that you think should exist, add one!

• Bindings, Properties, and Observers – Learn about the core notification technology that drives SproutCore.
• About the SproutCore Build Tools – Explanation of how the SproutCore Build Tools work.
• About View Helpers – Learn how to use view helpers in your HTML
• SproutCore REST API – The Definitive Guide – Part 1 is a Quick Reference to get you up to speed on how to use the SproutCore REST ish API.

References

Reference documentation for parts of SproutCore not included in the API Reference Documentation. If you would like to help document another part of the framework add a page here!

• Glossary – Brief descriptions of SproutCore terminology.
• Newbie FAQ – Frequently asked Question and Answers that SproutCore beginners have.
• View Helper Reference – Reference documentation for the view helpers used in rhtml templates for SproutCore
• SproutCore Framework Reference Documentation – At sproutcore.com.

Tips and Tricks

Hints, tips and tricks not related to the core SproutCore topics but useful nonetheless. If you have a useful tip that made your SproutCore coding easier, share it here.

• Book Recommendations – Read and share book recommendations about the larger world of JavaScript.
• Videos by Douglas Crockford – A serious of videos by Douglas Crockford on JavaScript
• IE Development Tips – IE is its own beast. If you are writing code for IE, follow this mish-mash of tips and tricks to keeps things tidy.

Proposals

If you have a new idea for SproutCore you would like to propose and you need a place to document it while the idea is developed, you can add a page for it here.

• Caja-compatibility for SproutCore—Is this even possible?
• SC.IndexScrollerView – Special pagination view that works well with incremental rendering.
• Relational Object Graphs – some notes I’ve made about making them work in SC and on the backend
• Performance – some suggested guidelines for the SproutCore project to follow, modeled after WebKit

Housekeeping Guides

• Wiki Editing Guidelines – General housekeeping guides and procedures used to run the SproutCore project.
• Documentation Conventions – How documentation should be written for SproutCore source code.
• Sproutbot – Information on how to use the #sproutcore IRC channel’s automated chat bot.
• Releasing a SproutCore Gem – Information for maintainers on how to release a new SproutCore GEM.

Other

• SproutCore Demo Awards 1 – Entry page for the SproutCore demo awards 1.
• Browser and Flash Support – Official position on SproutCore’s support for web browsers and Flash.
• jsDoc Plugin Hooks – For extending the jsDoc system.

Related Links

• SproutCore Dev Forums – Forums for discussing SproutCore and other related related technologies.
• RedBull: The SproutCore IDE – Info on SproutCore’s in-development IDE and visual view builder.

Comments

For anyone looking to write a “How To” that would be really helpful to newbies, I would love to see a walk through of creating the Contacts sample app from start to finish following the workflow that one would follow when writing a Sproutcore app from scratch. It would be really great if it could upgrade the code to support server side storage assuming a RESTful server. Triple bonus points for doing it as a screencast.

Added Sproutcore Updates and Versions to Quick Links but perhaps it fits better under references??? – raydaly

I’ve done some pruning of the howtos/tutorials section to make things easier to find – endash