Skip to content
A Yeoman generator to create an XPages runtime compatible On Disk Project (ODP), for quick and consistent application scaffolding.
JavaScript Java
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
__tests__
generators
.all-contributorsrc
.codecov.yml
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.npmrc
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
package-lock.json
package.json

README.md

generator-xsp

yo xsp

a yeoman generator to scaffold an XPages runtime (xsp) compliant On Disk Project (ODP)

NPM version Build Status Dependency Status Coverage Status Codacy Badge semantic-release npm PRs Welcome All Contributors

Try With No Install

Run:

npm init yo xsp

What's that? It's the npm init command executing create-yo with generator-xsp as an argument to execute. With npx it can be achieved with.

npx -p yo -p generator-xsp -c 'yo xsp'

Full Installation

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

npm install -g yo
npm install -g generator-xsp

Use

Then generate your new project:

mkdir my-new-proj
cd my-new-proj
yo xsp

Example

asciicast

Import to IBM Domino Designer

Importing your On Disk Project (ODP) into IBM Domino Designer is the end-goal. This will not work as a full application in its NSF container without being interacted with from a Domino Designer instance.

If you need help getting started with source control and its relationship to Domino/XPages applicaitons, you may wish to get started at Notes in 9 episode 131: Use SourceTree for Better XPages Source Control.

Sub-Generators

A sub-generator is one that creates/scaffolds a part or parts of an app. By default, yeoman will generator the entirety of the defined app. For example, if one were to look at generator-angular, you would find that you can scaffold an app or a specific directive or filter, etc. The format of this follows the basics of yo xsp:<sub-generator>.

Available are:

  • XPages, yo xsp:xpage
  • Custom Controls, yo xsp:cc
  • Java Classes, yo xsp:class
  • Java Classes configured as beans, yo xsp:bean
  • a CustomRestService bean and integration into an api.xsp XPage via xe:restService, yo xsp:rest

[Road Map][roadmap]

Want More?

Feel free to report bugs in Issues. If you would like to contribute code, read the CONTRIBUTING guide, then create a Pull Request.

Contributors

Thanks goes to these wonderful people (emoji key):


Eric McCormick

💬 📝 🐛 💻 📖 💡 🚇 👀 ⚠️ 🔧 📹

Oliver Busse

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

License

The code in this project governs my unique contributions and is open, free to use and redistribute or modify, for public or private use, without warranty or liability.

The MIT License (MIT) © 2016 Eric McCormick

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.