Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/saojs/sao

⚔ Futuristic scaffolding tool
https://github.com/saojs/sao

boilerplate generator sao scaffolding template vue-cli yeoman

Last synced: about 2 months ago
JSON representation

⚔ Futuristic scaffolding tool

Awesome Lists containing this project

README

        

## ATTENTION: [I'm working on SAO v2](https://github.com/saojs/sao/pull/145) without an ETA, if you want to get it shipped faster, [please consider sponsoring me](https://github.com/sponsors/egoist).






NPM version NPM downloads Build Status install size donate chat

## Motivation

**SAO** was made because **yeoman**, while powerful, is too complex. **vue-cli**, on the other hand, is more than a scaffolding tool and lacks some important features like *unit testing*. **SAO** combines the powerful core features of **yeoman** with the simplicity of **vue-cli** into a single application.

**SAO** is compatible with:

- Regular git repo (simply download it)
- SAO generator as git repo
- SAO generator as npm package
- SAO generator in local folder

⚡ ️**Both repo and npm package can be used offline.**

## Quick Start

```bash
npm i -g sao

# An official generator for creating a Node.js project
# Generate from git repo
sao saojs/sao-nm my-module
# Or from npm package (npm.im/sao-nm)
sao nm my-module
```

For detailed usage please head to https://sao.vercel.app

## Related

- [Awesome SAO](https://github.com/saojs/awesome-sao) - A curated list of delightful SAO resources.
- [SAO articles on medium.com](https://medium.com/saojs).

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

**SAO** © [EGOIST](https://github.com/egoist), Released under the [MIT](https://egoist.mit-license.org/) License.

Authored and maintained by EGOIST with help from contributors ([list](https://github.com/saojs/sao/contributors)).

> [egoist.sh](https://egoist.sh) · GitHub [@EGOIST](https://github.com/egoist) · Twitter [@_egoistlily](https://twitter.com/_egoistlily)