{"_id":"55df3f6586ae7f0d00db4ca8","category":{"_id":"55df3f6486ae7f0d00db4ca6","__v":2,"project":"55df3f6386ae7f0d00db4ca2","version":"55df3f6486ae7f0d00db4ca5","pages":["55df3f6586ae7f0d00db4ca8","55e13854c13a5a0d00880e89"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-27T16:48:36.956Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"version":{"_id":"55df3f6486ae7f0d00db4ca5","__v":7,"project":"55df3f6386ae7f0d00db4ca2","createdAt":"2015-08-27T16:48:36.339Z","releaseDate":"2015-08-27T16:48:36.339Z","categories":["55df3f6486ae7f0d00db4ca6","55e1376cd052580d0038c9b9","55e1391926f51b0d009b1778","55e1d40a7d91840d008249ea","55e1d6e27d91840d008249eb","55e20132d052580d0038ca67","55fe3726473f380d000b268a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":17,"project":"55df3f6386ae7f0d00db4ca2","user":"55df3f52ddfb40170061cf96","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-27T16:48:37.806Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"## Installation using npm\n\n### Dependencies\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Dependencies\",\n  \"body\": \"You have to install dependencies first before using yaas, otherwise yaas will not launch\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"redis\",\n    \"h-0\": \"application\",\n    \"h-1\": \"version\",\n    \"0-1\": \">= 2.6.12\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# install dependencies\\nnpm install yaas\\n# please follow the install instructions to configure the server\",\n      \"language\": \"shell\",\n      \"name\": \"install-npm\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Important notice\",\n  \"body\": \"yaas is not a module, it is a stand-alone server application that should not be used using require\"\n}\n[/block]\n## Installation from downloaded .zip\n[block:embed]\n{\n  \"html\": false,\n  \"url\": \"https://codeload.github.com/r1cebank/yaas/zip/release%401.1.1\",\n  \"title\": null,\n  \"favicon\": null\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"npm install\",\n      \"language\": \"shell\",\n      \"name\": \"install-github\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Information\",\n  \"body\": \"this is the recommended method of installation after unzip the files\"\n}\n[/block]\n## Build\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Dependencies\",\n  \"body\": \"Before build, make sure you run these commands\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"npm install -g gulp\\nnpm install\",\n      \"language\": \"shell\",\n      \"name\": \"build-pre\"\n    }\n  ]\n}\n[/block]\n### Building yaas & run\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"npm start\",\n      \"language\": \"shell\",\n      \"name\": \"build\"\n    }\n  ]\n}\n[/block]\n#### You should see this\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"verbose: [bootstrap] : [hash]\\nverbose: [bootstrap] : current configuration\\nverbose: [bootstrap] : [object]\\nverbose: [bootstrap] : worker kue created/restored\\ninfo: [bootstrap] : undefined is loaded\\ninfo: [authority:local] : loading modules\\ninfo: [authority:local] : modules loading complete\\nverbose: [queueworker] : setting concurrency 3\\ninfo: [bootstrap] : Bootstrap complete!\\ninfo: [index] : HTTP Server running at: :::3939\",\n      \"language\": \"text\",\n      \"name\": \"server-output\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Information\",\n  \"body\": \"At this stage, yaas is running on local machine listening port 3939, it is ok to test some functions, but a few configurations will be needed before open this to public.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Default API Key\",\n  \"body\": \"c9cba3d805ff526866d27b5504005766\"\n}\n[/block]","excerpt":"This page will help you get started with yaas. You'll be up and running in a jiffy!","slug":"getting-started","type":"basic","title":"Getting Started with yaas"}

Getting Started with yaas

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

## Installation using npm ### Dependencies [block:callout] { "type": "warning", "title": "Dependencies", "body": "You have to install dependencies first before using yaas, otherwise yaas will not launch" } [/block] [block:parameters] { "data": { "0-0": "redis", "h-0": "application", "h-1": "version", "0-1": ">= 2.6.12" }, "cols": 2, "rows": 1 } [/block] [block:code] { "codes": [ { "code": "# install dependencies\nnpm install yaas\n# please follow the install instructions to configure the server", "language": "shell", "name": "install-npm" } ] } [/block] [block:callout] { "type": "warning", "title": "Important notice", "body": "yaas is not a module, it is a stand-alone server application that should not be used using require" } [/block] ## Installation from downloaded .zip [block:embed] { "html": false, "url": "https://codeload.github.com/r1cebank/yaas/zip/release%401.1.1", "title": null, "favicon": null } [/block] [block:code] { "codes": [ { "code": "npm install", "language": "shell", "name": "install-github" } ] } [/block] [block:callout] { "type": "info", "title": "Information", "body": "this is the recommended method of installation after unzip the files" } [/block] ## Build [block:callout] { "type": "warning", "title": "Dependencies", "body": "Before build, make sure you run these commands" } [/block] [block:code] { "codes": [ { "code": "npm install -g gulp\nnpm install", "language": "shell", "name": "build-pre" } ] } [/block] ### Building yaas & run [block:code] { "codes": [ { "code": "npm start", "language": "shell", "name": "build" } ] } [/block] #### You should see this [block:code] { "codes": [ { "code": "verbose: [bootstrap] : [hash]\nverbose: [bootstrap] : current configuration\nverbose: [bootstrap] : [object]\nverbose: [bootstrap] : worker kue created/restored\ninfo: [bootstrap] : undefined is loaded\ninfo: [authority:local] : loading modules\ninfo: [authority:local] : modules loading complete\nverbose: [queueworker] : setting concurrency 3\ninfo: [bootstrap] : Bootstrap complete!\ninfo: [index] : HTTP Server running at: :::3939", "language": "text", "name": "server-output" } ] } [/block] [block:callout] { "type": "danger", "title": "Information", "body": "At this stage, yaas is running on local machine listening port 3939, it is ok to test some functions, but a few configurations will be needed before open this to public." } [/block] [block:callout] { "type": "info", "title": "Default API Key", "body": "c9cba3d805ff526866d27b5504005766" } [/block]