@existdb/generator-exist

generator-exist

exist app scaffolding

Let Yeoman take care of creating directory and file scaffolds for different types of exist-db EXpath packages. Just answer the prompts about what you want to build, and a sensible directory structure with fully configured readmes, buildfiles, etc will be set up for you.

No more manual closing of html5 tags, inserting app names into config files, or wondering if you actually increase the version number in all the places.

Installation

First, install Yeoman and generator-exist using npm (we assume you have pre-installed node.js).

From GitHub

To install a pre-release version:

npm i -g yo
npm i -g git://github.com/eXist-db/generator-exist.git

Official release

To install a version published to npm:

npm i -g yo
npm i -g @existdb/generator-exist

From Source

Alternatively, if you have cloned this repo from GitHub. You can symlink your local clone into your global node environment. This is particularly useful during development. From inside the folder with the cloned repo:

npm install -g yo
npm i
npm link

Using the Generator

Then generate your new project: Create a new project folder and navigate to it in you CLI.

mkdir myApp
cd myApp

Then run the generator. If you installed from source or GitHub,

yo exist

or if you installed from npm:

yo @existdb/exist

Note: If you told yeoman to use Github for your new project, your project will start initialized with all files added, out of the box.

Some of the answers, such as username will be stored after the initial run of the generator. So you only have to type them once.

Development

If you want to contribute another template or option, please take a look at the issue tracker. Pull request are always welcome. This generator uses mocha for unit testing. Please make sure to add tests when opening a PR.

License

MIT © Duncan Paterson