generator-ego
v0.35.2
Published
A Yeoman generator with useful general sub generators and the possibility to expand it by JavaScript.
Downloads
71
Maintainers
Readme
generator-ego
A Yeoman generator with useful general sub generators and the possibility to be expand it by JavaScript.
The project is currently under heavy development! Feel free to contribute and/or give us your feedback.
Install
First keep sure to have Yeoman installed:
npm install -g yo
Now, you can install the generator by
npm install -g generator-ego
Run
Simply execute
yo ego
from your console.
Build in templates
| Name | Description |
| ------------- | ------------- |
| service-node-express-react
| Creates a service with a React frontend and database support. |
Additional generators
Create a yo-ego.js
file inside your home directory and use the following skeleton:
// the keys are the display texts, which
// are shown in the generator's menu
// at the beginning of the execution
exports.generators = {
'My first generator': async function() {
// 'this' contains the underlying Generator
// instance: https://github.com/egodigital/generator-ego/blob/master/generators/app/index.js
this.log(
'From my 1st generator'
);
},
// path to an external script file
//
// the file must contain a public / exported
// 'run()' function / method
//
// relative paths will be mapped to the
// user's home directory
'My 2nd generator': 'my-2nd-generator.js',
};
Have a look at the external-generator.example.js
file to get an idea, how to create a generator (file).
Documentation
Have a look at the wiki to learn more about that generator.
Contribute
The contribution guide explains, how to implement a new, build-in generator, work with the code and open a pull request.