skyrocket-cli/readme.md

Command line interface for rapid Skyrocket projects development.

# Skyrocket CLI

> Skyrocket CLI is a simple, fast, efficient package for initlizing projects build with Craft CMS or other frameworks.

## Getting Started

### Prerequisites

- *Node.js* (>=6.x, 8.x or 10.x preferred)
- *NPM* version 3+
- *Git*

### Installing

Install:

```
npm install -g skyrocket-cli
# OR
yarn global add skyrocket-cli
```

Create a project:

```
mkdir your-project-folder
cd your-project-folder
skyrkt init
```

### Start Development

Once created project with `skyrkt`, find more instruction from the `readme.md` inside project.

### Support Frameworks
currently, the skyrocket-cli only support the following templates:
- Craft CMS 2 (ES6 + PostCSS + Webpack + Docker)
- Craft CMS 3 (ES6 + PostCSS + Webpack + Docker)

we plan to add the following:
- Craft CMS + React.js
- Craft CMS + Next.js
- Craft CMS + Vue.js
- Wordpress

## Contributing

[Skyrocket](https://skyrocket.is) has written a comprehensive guide to get started with contributing to Skyrocket projects. You can view the Skyrocket Tettra Document.

## Authors

* **Skyrocket Digital** - *Owner* - [Website](https://skyrocket.is)
* **Ethan Zhang** - *Initial work* - [Website](https://runhangz.com)

## License

Skyrocket-CLI is licensed under the Apache License, Version 2.0. See
[LICENSE](https://github.com/docker/docker/blob/master/LICENSE) for the full
license text.