Kanso documentation

Developing applications

Guides to help you get started building apps with Kanso. Here are some recommended tools and approaches, but since apps just use normal HTML and JavaScript, there are a whole host of frameworks and libraries available to you that may not be listed here.

For more information on the tools used by the community, browse the package repository.

Getting started

• Simplest possible app
• Using CommonJS modules
• Adding example data
• Defining queries
• Third-party modules

Videos

Screencasts and other videos on developing applications with Kanso.

• CouchApps Reborn - A quick introduction to Kanso and the latest development tools

Users and authentication

CouchDB ships with a ready-made user database and cookie authentication built-in. These guides are releated to the login, logout and signup of users.

• The users database
• The session module
• The users module

Permissions and validation

Manage who can access which databases and ensure the data in your database is valid.

• User roles
• Database security
• Validate doc updates
• Getting started with CouchTypes

Forms

The automatic rendering, parsing and validation of forms based on models or document type definitions.

• Simplest possible form
• CouchTypes forms
• Custom widgets

Frameworks

Most these frameworks provide client-side URL Routing, some with additional support for models or templates.

• Duality
• Spine
• Getting started with Spine

Templating

There are a large number of client-side templating options available, and you probably already have your own preference. Here are some of the templating libraries documented for use with Kanso, though its possible to use any JavaScript template system.

• Handlebars
• Dust

Testing

• Running unit tests from Node
• Running unit tests in the browser
• Continuous Integration With Travis

Other

• Porting from Kanso 0.0.7
• Using coffeescript with kanso
• Kanso for node.couchapp.js and reupholster developers
• Kanso for developers using the python couchapp tool
• Sharing code between views
• Autopush Changes With Watchr

Reference

This section covers the core tools and concepts underpinning the Kanso approach to development and should be relevant to every application developer, regardless of their choice of frameworks or other resources.

Installation

• Installing on Windows
• Install

Kanso Tools

The command-line program used to manage packages and applications.

• Deploying / building applications
• Working with JSON data
• Configuration .kansorc
• Autocomplete
• Commands

Packages

Using, building and distributing Kanso packages. These packages form the core of the Kanso approach to development and allow you to easily share build steps (such as compiling coffee-script or loading attachments) or resources (including libraries, views, templates etc).

• kanso.json format
• Managing dependencies
• Publishing Packages
• Build-steps (preprocessors, postprocessors)
• Using development packages (configuration)

Community

For more information, examples, or answers to questions not answered by this wiki, the Kanso community may be able to provide you with support.

• Getting help
• Companies and projects using Kanso