generator-openstack

generator-openstack

generator-openstack is OpenStack's JavaScript project templating and maintenance engine. It permits you to:

• ...create a new OpenStack JavaScript project.
• ...update an existing project with new settings, requirements, and tools.

Quick Start

Creating and updating a project follows the exact same steps:

• Prerequisites: nodejs, npm
• npm install -g yo generator-openstack
• cd my_project_directory
• yo openstack

The generator also provides a non-interactive mode: yo openstack --non-interactive

Contributing

This project uses itself as a code management tool. In order to set up your environment for development, please follow these steps:

• Prerequisites: nodejs, npm, git, git review
• npm install -g yo
• git clone git://git.openstack.org/openstack/js-generator-openstack
• cd js-generator-openstack
• npm install
• git review -s

This should set up your project directory and make it ready for development.

Some useful development commands

• npm link - Link this project into your global npm runtime. This allows you to run the project (via yo openstack) as if it was installed via npm install -g
• npm test - Run all the tests.
• npm run lint - Perform a linting check.

TODO List

Looking for something to add? Here's a quick checklist:

• Prompt user for the project name, and make it accessible to all submodules.
• Choose the type of project they'd like to generate: Library, Web UI, or CLI Node App
  • Basic project setup for these different types will also be needed.
• package.json creation and maintenance
• Ensure that license is persisted into package.json
• dependency propagation from global requirements
• CLI documentation for --non-interactive

Project Resources

• Source code
• How to contribute to OpenStack
• Code reviews workflow