{"_id":"55fd9c6f56d6990d00a6cab3","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"},"project":"54d64e6b276f8e0d00feab95","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"},"__v":1,"updates":["54e1137cd2adf219000eebbd","54e1a4d0f98df80d00683f3e","54ec76f50d73bd2b00b3463d","5626213ca96b420d00fe1071"],"next":{"pages":[],"description":""},"createdAt":"2015-02-07T17:42:04.973Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"In order to use `kick`, make sure you have node.js and npm installed: \n\nhttps://docs.npmjs.com/getting-started/installing-node\n\n**Note:** You need node >=4.0.0 in order to use angular-kick\n\nThen, install angular-kick by running:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ npm install -g kick\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Pre Requirments\",\n  \"body\": \"Please ensure you have webpack installed globally before using angular-kick:\\n\\n```npm install -g webpack```\\n```npm install -g webpack-dev-server```\"\n}\n[/block]\n# Creating New Application\n\nCreating new applications is as simple as running\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick new application-name\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nThis will create a new folder application_name and create an application named ApplicationName.\n\n# Using Generators\n\nYou can generate plenty of things with kick: \n* states\n* models\n* services\n* directives\n* filters\n* partials\n* configs\n* stylesheets\n\nBy default, test files will be generated as well.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ kick generate <type> <name> [options]\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"This page will help you get started with angular-kick. You'll be up and running in a jiffy!","slug":"getting-started","type":"basic","title":"Getting Started"}

Getting Started

This page will help you get started with angular-kick. You'll be up and running in a jiffy!

In order to use `kick`, make sure you have node.js and npm installed: https://docs.npmjs.com/getting-started/installing-node **Note:** You need node >=4.0.0 in order to use angular-kick Then, install angular-kick by running: [block:code] { "codes": [ { "code": "$ npm install -g kick", "language": "shell" } ] } [/block] [block:callout] { "type": "warning", "title": "Pre Requirments", "body": "Please ensure you have webpack installed globally before using angular-kick:\n\n```npm install -g webpack```\n```npm install -g webpack-dev-server```" } [/block] # Creating New Application Creating new applications is as simple as running [block:code] { "codes": [ { "code": "$ kick new application-name", "language": "shell" } ] } [/block] This will create a new folder application_name and create an application named ApplicationName. # Using Generators You can generate plenty of things with kick: * states * models * services * directives * filters * partials * configs * stylesheets By default, test files will be generated as well. [block:code] { "codes": [ { "code": "$ kick generate <type> <name> [options]", "language": "shell" } ] } [/block]