8a5eff7b66
inner function names are renamed to keep consistency with export names Change-Id: I9d121b0c440a9dd1d0c0037dca9298ba1dd156c0 |
||
---|---|---|
doc | ||
generators/app | ||
spec | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc | ||
.gitignore | ||
.gitreview | ||
.istanbul.yml | ||
.nsprc | ||
.yo-rc.json | ||
LICENSE | ||
README.md | ||
global-dependencies.json | ||
package.json |
README.md
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 (viayo openstack
) as if it was installed vianpm 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
- Source code
- Code review
- Task tracking (StoryBoard)
- Discussion on openstack develop mailing list with tag
[javascript]
- IRC:
#openstack-javascript
on freenode.net