| 1 | # skale
|
| 2 |
|
| 3 | [](https://gitter.im/skale-me/skale-engine?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 4 | [](https://travis-ci.org/skale-me/skale-cli)
|
| 5 |
|
| 6 | Create, test, deploy and run distributed NodeJS applications
|
| 7 |
|
| 8 | The skale command is the quickest and easiest way to create distributed
|
| 9 | scalable applications based on
|
| 10 | [skale-engine](https://www.npmjs.com/package/skale-engine) and then
|
| 11 | to execute them either locally or on the cloud.
|
| 12 |
|
| 13 | ## Install
|
| 14 |
|
| 15 | `skale` and `skale-engine` have been tested so far on Unix-like
|
| 16 | system such as Linux or MacOSX. MS-Windows is not supported.
|
| 17 |
|
| 18 | Assuming you have already installed [NodeJS](https://nodejs.org):
|
| 19 |
|
| 20 | sudo npm install -g skale
|
| 21 |
|
| 22 | This installs the skale command globally on your system.
|
| 23 |
|
| 24 | ## Getting started
|
| 25 |
|
| 26 | To create an application called `my_app`, simply run
|
| 27 |
|
| 28 | skale create my_app
|
| 29 |
|
| 30 | It will create a directory `my_app`, populate it with a template
|
| 31 | (hello world) application `my_app.js`, and install skale-engine
|
| 32 | dependency using [`npm`](https://npmjs.com).
|
| 33 |
|
| 34 | You can then go to `my_app` and run your app using `skale test`:
|
| 35 |
|
| 36 | cd my_app
|
| 37 | skale test
|
| 38 |
|
| 39 | To do something useful, modify your application by editing `my_app.js`,
|
| 40 | then run again using `skale run`.
|
| 41 |
|
| 42 | Under the hood, the `skale run` commands starts a skale-engine cluster on the
|
| 43 | the localhost at the first invocation, then simply executes `my_app.js`. You
|
| 44 | can check the status of the cluster using the `skale status` command, and stop
|
| 45 | it using `skale stop`.
|
| 46 |
|
| 47 | To go on further details, please refer to [documentation](https://skale-me.github.io/skale-engine/)
|
| 48 | and [skale examples](https://github.com/skale-me/skale-examples)
|
| 49 |
|
| 50 | ## Deploying an application
|
| 51 |
|
| 52 | *Coming soon*
|
| 53 |
|
| 54 | ## Usage
|
| 55 | ```
|
| 56 | Usage: skale [options] <command> [<args>]
|
| 57 |
|
| 58 | Create, run, deploy clustered node applications
|
| 59 |
|
| 60 | Commands:
|
| 61 | create <app> Create a new application
|
| 62 | test [<args>...] Run application on local host
|
| 63 | deploy [<args>...] Deploy application on skale cloud
|
| 64 | run [<args>...] Run application on skale cloud
|
| 65 | status print status of local skale cluster
|
| 66 | stop Stop local skale cluster
|
| 67 |
|
| 68 | Options:
|
| 69 | -h, --help Show help
|
| 70 | -V, --version Show version
|
| 71 | ```
|
| 72 |
|
| 73 | ## Community
|
| 74 |
|
| 75 | * [Gitter](https://gitter.im/skale-me/skale-engine) for support and
|
| 76 | discussion
|
| 77 | * [skale](https://groups.google.com/forum/#!forum/skale)
|
| 78 | mailing list for general discussion about use and development
|
| 79 |
|
| 80 | ## License
|
| 81 |
|
| 82 | [Apache-2.0](LICENSE)
|