generator-swell

Highly opinionated Yeoman generator for various types of Node.js, Angular & Aurelia projects with TypeScript.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

11

Maintenance

Last Commit

6mos ago

Contributors

8

Package

Dependencies

6

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

generator-swell ** Currently in Alpha **

** Note this is currently in Alpha **

Highly opinionated Yeoman generator for various types of Node.js (Chatbots, VSTS Extensions, and more) plus coming soon: Angular and Aurelia projects with TypeScript. Yes, there are others out there, but we wanted one that gave us a 100% of what we need. Pull Requests are encouraged and will be happily accepted (provided they pass the automated gates!).

NPM Stats Badge

NPM Version Badge npm License Badge

Circle CI Badge AppVeyor Status Test Results Badge Coverage Badge SonarQube Quality Gate Badge SonarQube Maintainability Badge

Installation

Ensure you have the necessary prerequisites outlined below. Then install the generator globally (note, you may need to use sudo):

npm i -g generator-swell

Prerequisites

This should be pretty obvious, but just in case here is what you will need:

  • Node.js We are developing on 8.x, but we also run our tests against 6.x, 8.x, 9.x, and 10.x
  • Yeoman

If you don't have Yeoman installed globally (note, you may need to use sudo):

npm i -g yo

Usage

yo swell

See the Usage Overview for detailed information about usage. Note you will need to cd into the newly created directory if you specify an app name that is different than the name of the directory you execute the yo command from.

Contributing

More details can be found in the Contribution Guidelines.

Click the below links to create a new issue:

Developing

The Swellaby Generator is developed using Typescript.
Here are some things you should know:

  • Run npm run dev:setup to configure your environment
  • Run npm link (as admin) to install the locally cloned generator globally so that you can see how it behaves

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial