| 1 | <p align="center">
|
| 2 | <img src="./docs/media/sao.png" width="150" />
|
| 3 | </p>
|
| 4 |
|
| 5 | <p align="center">
|
| 6 | <br>
|
| 7 | <a href="https://npmjs.com/package/sao"><img src="https://img.shields.io/npm/v/sao.svg?style=flat" alt="NPM version"></a> <a href="https://npmjs.com/package/sao"><img src="https://img.shields.io/npm/dm/sao.svg?style=flat" alt="NPM downloads"></a> <a href="https://circleci.com/gh/saojs/sao"><img src="https://img.shields.io/circleci/project/saojs/sao/master.svg?style=flat" alt="Build Status"></a> <a href="https://github.com/egoist/donate"><img src="https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat" alt="donate"></a> <a href="https://chat.egoist.moe"><img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg?style=flat" alt="chat"></a>
|
| 8 | </p>
|
| 9 |
|
| 10 | ## Motivation
|
| 11 |
|
| 12 | **yeoman** is too complex, while **vue-cli** is more than a scaffolding tool and lacks of some important features like *unit testing*, so I made **SAO**, basically it combines the powerful features of **yeoman** and the simplicity of **vue-cli**.
|
| 13 |
|
| 14 | **SAO** is compatible with:
|
| 15 |
|
| 16 | - Regular git repo (simply download it)
|
| 17 | - SAO template as git repo
|
| 18 | - SAO template as npm package
|
| 19 | - SAO template in local folder
|
| 20 |
|
| 21 | ⚡ ️**Both repo and npm package can be used offline.**
|
| 22 |
|
| 23 | ## Quick Start
|
| 24 |
|
| 25 | ```bash
|
| 26 | yarn global add sao
|
| 27 |
|
| 28 | # Example template for creating a Next.js project
|
| 29 | # Generate from git repo
|
| 30 | sao egoist/template-next new-project
|
| 31 | # Or from npm package (npm.im/template-next)
|
| 32 | sao next new-project
|
| 33 | ```
|
| 34 |
|
| 35 | For detailed usage please head to https://sao.js.org
|
| 36 |
|
| 37 | ## Related
|
| 38 |
|
| 39 | - [awesome-sao](https://github.com/egoist/awesome-sao) - A curated list of delightful SAO resources.
|
| 40 | - [SAO articles on medium.com](https://medium.com/saojs).
|
| 41 |
|
| 42 | ## Contributing
|
| 43 |
|
| 44 | 1. Fork it!
|
| 45 | 2. Create your feature branch: `git checkout -b my-new-feature`
|
| 46 | 3. Commit your changes: `git commit -am 'Add some feature'`
|
| 47 | 4. Push to the branch: `git push origin my-new-feature`
|
| 48 | 5. Submit a pull request :D
|
| 49 |
|
| 50 | ## Author
|
| 51 |
|
| 52 | **sao** © [EGOIST](https://github.com/egoist), Released under the [MIT](https://egoist.mit-license.org/) License.<br>
|
| 53 | Authored and maintained by EGOIST with help from contributors ([list](https://github.com/saojs/sao/contributors)).
|
| 54 |
|
| 55 | > [egoist.moe](https://egoist.moe) · GitHub [@egoist](https://github.com/egoist) · Twitter [@_egoistlily](https://twitter.com/_egoistlily)
|
| 56 |
|
| 57 |
|