{"_id":"55fd9c6f56d6990d00a6cab2","category":{"_id":"55fd9c6e56d6990d00a6ca9e","pages":["55fd9c6f56d6990d00a6cab2","55fd9c6f56d6990d00a6cab3","55fd9c6f56d6990d00a6cab4","55fd9c6f56d6990d00a6cab5","55fd9c6f56d6990d00a6cab6"],"version":"55fd9c6d56d6990d00a6ca9d","__v":1,"project":"54d64e6b276f8e0d00feab95","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-07T17:42:04.249Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"54d64e31276f8e0d00feab94","version":{"_id":"55fd9c6d56d6990d00a6ca9d","project":"54d64e6b276f8e0d00feab95","__v":1,"createdAt":"2015-09-19T17:33:33.368Z","releaseDate":"2015-09-19T17:33:33.368Z","categories":["55fd9c6e56d6990d00a6ca9e","55fd9c6e56d6990d00a6ca9f","55fd9c6e56d6990d00a6caa0"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.4.0","version":"1.4.0"},"project":"54d64e6b276f8e0d00feab95","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-07T17:49:20.388Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:html]\n{\n  \"html\": \"<div>\\n  <img src=\\\"https://files.readme.io/jbRDg11TBC4VlmEU0umr_logo.png\\\" alt=\\\"angular-kick logo\\\"/>\\n</div>\"\n}\n[/block]\nAngular-kick is opinionated kickstarter and generator for classic single-page AngularJS applications. Based on **ECMAScript 6,** **webpack** and **best practices**. It allows you to create a working state-based application in no time, and add develop with ease.\n\nBrought to you by [500Tech](http://500tech.com).\n\n# Getting Out Of Your Way\nThough angular-kick is opinionated and follows best practices, it won’t get in your way with too many default packages and decisions. It won’t ask you anything when you generate new application. It just works.\n\n# Best Practices\nAngular-kick uses conventions from [AngularJS Style Guide](https://github.com/toddmotto/angularjs-styleguide) by Todd Motto. It best fits classic state-based approach for applications rather than component based approach.\n\nIt also comes with handy defaults and good decisions about application structure and development workflow organization.\n\n# Folder structure\nApplications generated with angular-kick enforce folder structure somewhere between organization by type and organization by feature. All services, directives, filters and configs are stored in folders by type, but all the controllers and partials are represented in states folder just as they appear in router config.\n\n# Naming convention\n* Controller names are suffixed with `Controller` suffix. All other AngularJS entities are written without suffixes. \n* Controller As syntax binds scope to controller name without the `Controller` suffix.\n* Service names start with a capital letter.\n* Partial html files are prefixed with underscore (_).\n* Directive controller names start with a lowercase letter.\n\n# Module naming\nThe application is separated to modules by type. This saves you from writing too many module injections on one hand, and makes the application easy to test on the other hand.","excerpt":"","slug":"overview","type":"basic","title":"Overview"}
[block:html] { "html": "<div>\n <img src=\"https://files.readme.io/jbRDg11TBC4VlmEU0umr_logo.png\" alt=\"angular-kick logo\"/>\n</div>" } [/block] Angular-kick is opinionated kickstarter and generator for classic single-page AngularJS applications. Based on **ECMAScript 6,** **webpack** and **best practices**. It allows you to create a working state-based application in no time, and add develop with ease. Brought to you by [500Tech](http://500tech.com). # Getting Out Of Your Way Though angular-kick is opinionated and follows best practices, it won’t get in your way with too many default packages and decisions. It won’t ask you anything when you generate new application. It just works. # Best Practices Angular-kick uses conventions from [AngularJS Style Guide](https://github.com/toddmotto/angularjs-styleguide) by Todd Motto. It best fits classic state-based approach for applications rather than component based approach. It also comes with handy defaults and good decisions about application structure and development workflow organization. # Folder structure Applications generated with angular-kick enforce folder structure somewhere between organization by type and organization by feature. All services, directives, filters and configs are stored in folders by type, but all the controllers and partials are represented in states folder just as they appear in router config. # Naming convention * Controller names are suffixed with `Controller` suffix. All other AngularJS entities are written without suffixes. * Controller As syntax binds scope to controller name without the `Controller` suffix. * Service names start with a capital letter. * Partial html files are prefixed with underscore (_). * Directive controller names start with a lowercase letter. # Module naming The application is separated to modules by type. This saves you from writing too many module injections on one hand, and makes the application easy to test on the other hand.