x
/
js-generator-openstack
Code Issues Proposed changes
RETIRED, Yeoman Project Management template for JavaScript Projects.
83 Commits 1 Branch 4 Tags 790 KiB
Go to file
Yujun Zhang 5c9e5bbeaf Remove IIFE in all scripts 
It is not required by node.js, but introduce troubles while
generating documents with jsdoc3.

Refer to https://github.com/jsdoc3/jsdoc/issues/456

Change-Id: I6664f1be0fc3e86f3a7e3843d557786c37df1c5e
 		2016-07-05 16:38:35 +08:00
doc Added Sphinx-based documentation framework and specs repo. 2016-06-17 12:58:42 -07:00
generators/app Remove IIFE in all scripts 2016-07-05 16:38:35 +08:00
spec Remove IIFE in all scripts 2016-07-05 16:38:35 +08:00
.editorconfig Updates from generator-generator 2016-03-22 04:24:04 -07:00
.eslintignore Created Structure Module 2016-06-15 05:33:31 -07:00
.eslintrc Remove IIFE in all scripts 2016-07-05 16:38:35 +08:00
.gitignore Added Sphinx-based documentation framework and specs repo. 2016-06-17 12:58:42 -07:00
.gitreview Corrected .gitreview 2016-05-11 18:13:55 +00:00
.istanbul.yml Corrected istanbul.yml config to put reports in /cover 2016-03-29 11:07:04 -07:00
.nsprc Add nsp to prepublish hook 2016-06-15 05:33:31 -07:00
.yo-rc.json Created Structure Module 2016-06-15 05:33:31 -07:00
LICENSE Removed "How to apply" section from LICENSE 2016-03-29 10:58:06 -07:00
README.md Add more project resources 2016-05-26 09:03:38 +08:00
global-dependencies.json Upgrade eslint version to version 2 2016-07-04 17:22:54 +08:00
package.json Upgrade eslint version to version 2 2016-07-04 17:22:54 +08:00

README.md

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