x
/
js-generator-openstack
Code Issues Proposed changes
RETIRED, Yeoman Project Management template for JavaScript Projects.
28 Commits 1 Branch 4 Tags 790 KiB
Go to file
Michael Krotscheck 2937551abb 1.1.2 2016-03-30 04:11:24 -07:00
generators/app Added .gitignore creation 2016-03-29 10:59:06 -07:00
spec Added .gitignore creation 2016-03-29 10:59:06 -07:00
.editorconfig Updates from generator-generator 2016-03-22 04:24:04 -07:00
.eslintignore Corrected istanbul.yml config to put reports in /cover 2016-03-29 11:07:04 -07:00
.eslintrc Eslint support 2016-03-29 08:33:23 -07:00
.gitignore Added .gitignore creation 2016-03-29 10:59:06 -07:00
.gitreview Ran yo openstack on project 2016-03-22 10:44:23 -07:00
.istanbul.yml Corrected istanbul.yml config to put reports in /cover 2016-03-29 11:07:04 -07:00
.travis.yml Updated travis options 2016-03-22 07:33:41 -07:00
.yo-rc.json Removed "How to apply" section from LICENSE 2016-03-29 10:58:06 -07:00
LICENSE Removed "How to apply" section from LICENSE 2016-03-29 10:58:06 -07:00
README.md Updated README with somewhat more useful information 2016-03-30 04:05:35 -07:00
package.json 1.1.2 2016-03-30 04:11:24 -07: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

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.

Project Resources