guides.yml

title: SproutCore Guides
description: These guides are designed to help you get up and running and feeling productive with SproutCore.

authors:
  Documentation Team:
    - name: Yehuda Katz
      nick: wycats
      description: Yehuda works for Strobe and is a member of the SproutCore core team.
    - name: Peter Wagenet
      nick: pwagenet
      image: pwagenet.jpg
      description: Peter works for Strobe and is a member of the SproutCore core team.
  Designers:
    - name: Jason Zimdars
      nick: jz
      description: Jason Zimdars is an experienced creative director and web designer who has lead UI and UX design for numerous websites and web applications. You can see more of his design and writing at <a href="http://www.thinkcage.com/">Thinkcage.com</a> or follow him on <a href="http://twitter.com/JZ">Twitter</a>
  Contributors:
    - name: Alex Iskander
      nick: ialexi
      description: Member of the SproutCore core team.
    - name: Florian Kugler
      nick: fkugler
      description: ""
    - name: Shawn Morel
      nick: shawnmorel
      description: Shawn Morel is a software generalist with lots of experience building user interfaces in Cocoa, Flex, and bare-bones HTML.
    - name: Scott "oldfartdeveloper" Smith
      nick: oldfartdeveloper
      image: oldfartdeveloper.jpg
      description: Scott is a Senior Developer at Hedgeye Risk Management.
    - name: Devin Torres
      nick: dtorres
      description: ""
    - name: 'Vibul "Veebs" Imtarnasan'
      nick: veebs
      description: ""

index:
  Start Here:
    - title: Install
      url: install
      text: "In this guide we'll walk you through installing SproutCore."
    - title: Getting Started with HTML-Based Apps
      url: html_based
      text: "Learn how to build a robust web app using the power of SproutCore along with the technologies you already know, like HTML and CSS."
      construction: true
    - title: Getting Started
      url: getting_started
      text: "Jump start your SproutCore development by playing along as we build a fully functional Todo List application."
      construction: true
    - title: Core Concepts
      url: core_concepts
      text: "In this guide, we will touch on many of the core concepts of SproutCore like bindings and the run loop. We'll cover just enough to get you going with out getting bogged down in the details. If you want to learn more, take a look at the detailed overviews of these concepts in the \"Digging Deeper\" section."
      construction: true
  Models:
    - title: SproutCore Records
      url: records
      text: "The SproutCore data framework is a full-featured ORM-like framework for working with data in SproutCore. Learn about the SproutCore data framework and how you can use it to interact with your data sources."
      construction: true
    - title: Hooking Up to a Backend
      url: data_source
      text: "This guide covers how to create a SproutCore data source, which will retrieve data from your servers and make them available to the SproutCore Records you designed in the previous guide."
      construction: true
    - title: Transactions Using Nested Stores
      url: nested_stores
      text: "SproutCore provides a powerful facility for allowing your app's users to make changes to local data, then commit or rollback the changes as needed. Learn how to use 'nested stores' to manage the state of your data as it moves through your user's edits."
      construction: true
    - title: Using Fixtures
      url: fixtures
      text: "In order to facilitate rapid development, SproutCore provides a facility for using pre-set fixture data as your data source. This guide covers how to set up your fixtures, and how to replace them with your real server once you're ready to get going."
  Views:
    - title: Core View Concepts
      url: views
      text: "In this guide, we will cover the basics of SproutCore views, and show you how to customize the built-in SproutCore views for your own use."
      construction: true
    - title: Building Your Own Views
      url: custom_views
      text: "Most applications will quickly go beyond the built-in SproutCore views. In this guide, we will cover how to build and style your own views."
      construction: true
  Theming:
    - title: Theming Your App
      url: theming_app
      text: "In this guide, we'll cover how to change the style of SproutCore controls in your app. As an example, we'll re-theme an SC.ButtonView."
      construction: true
    - title: Writing Themeable Controls
      url: themeable_controls
      text: "In this guide, we'll go over to how to develop a control that can be themed. This can be useful if you want to have different visual displays in your application (like a regular and overlay theme) or when distributing a theme for wider use."
      construction: true
    - title: "Using Chance, SproutCore's CSS framework"
      url: chance
      text: "Chance is SproutCore's CSS preprocessor. In this guide, you will learn how to use the CSS extensions that come with Chance to streamline your styling workflow."
      construction: true
  Testing:
    - title: "Unit Testing"
      url: unit_test_framework
      text: "SproutCore has an easy-to-learn unit test facility that can be used to drive SproutCore test-driven development.  This guide describes the basic SproutCore test commands."
    - title: "Adding a Unit Test"
      url: adding_unit_test
      text: "Adding a unit test automatically or manually."
    - title: "Writing Unit Tests"
      url: writing_unit_tests
      text: "Describes how to write unit tests using module and test functions"
    - title: "Running Unit Tests"
      url: running_unit_tests
      text: "How tests are loaded and executed by the test runner."
    - title: "Testing Guidelines in SproutCore"
      url: testing_guidelines
      text: "Developing a SproutCore application using test-driven development (TDD)."
      construction: true
    - title: "SproutCore Development Using TDD"
      url: todos_tdd
      text: "Show implementing the TODOs project using TDD."
      construction: true