54fed59885
run `npm run jsdoc` to generate api documentation in `jsdoc_build` Change-Id: Ica8202a10b1d2c2a35453637f600501a71e412b7 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
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-openstackcd my_project_directoryyo 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 yogit clone git://git.openstack.org/openstack/js-generator-openstackcd js-generator-openstacknpm installgit 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 (viayo openstack) as if it was installed vianpm install -gnpm test- Run all the tests.npm run lint- Perform a linting check.
TODO List
Looking for something to add? Please check StoryBoard
Project Resources
- Source code
- Code review
- Task tracking (StoryBoard)
- Discussion on openstack develop mailing list with tag
[javascript] - IRC:
#openstack-javascripton freenode.net