x
/
js-generator-openstack
Code Issues Proposed changes
js-generator-openstack/README.md

2.0 KiB
Raw Blame History

generator-openstack

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

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

Quick Start

Creating and updating a project follows the exact same steps:

  1. Prerequisites: nodejs, npm
  2. npm install -g yo generator-openstack
  3. cd my_project_directory
  4. 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:

  1. Prerequisites: nodejs, npm, git, git review
  2. npm install -g yo
  3. git clone git://git.openstack.org/openstack/js-generator-openstack
  4. cd js-generator-openstack
  5. npm install
  6. 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? Please check StoryBoard

Project Resources

Workflow