https://github.com/fed/generator-ui-component
A Yeoman generator for scaffolding reusable, standalone ui-components
https://github.com/fed/generator-ui-component
Last synced: about 2 months ago
JSON representation
A Yeoman generator for scaffolding reusable, standalone ui-components
- Host: GitHub
- URL: https://github.com/fed/generator-ui-component
- Owner: fed
- Created: 2015-10-26T03:40:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-26T03:52:40.000Z (over 9 years ago)
- Last Synced: 2025-01-18T13:38:07.989Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 113 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# generator-ui-component
A Yeoman generator for scaffolding reusable, standalone ui-components.
## Built-in packages
* [Sass](http://sass-lang.com/): CSS Preprocessor
* [Compass](http://compass-style.org/): Less mixin library
* [RequireJS](http://requirejs.org/): Asynchronous JavaScript file and module loader
* [jQuery](https://jquery.com/): Feature-rich JavaScript library
* [Lodash](https://lodash.com/): A JavaScript utility library
* [Hogan.js](http://twitter.github.io/hogan.js/): Templating engine
* [The Intern](https://theintern.github.io/): Unit and Functional testing framework
* [Grunt](http://gruntjs.com/): Task runner
## Creating a new ui-component
1. Setup [npm](https://nodejs.org/) properly for your development environment.
2. Install [Yeoman](http://yeoman.io/) and its required libraries:
```
npm install -g yo grunt-cli
```
3. Install the [ui-component](https://github.com/fknussel/generator-ui) generator:
```
npm install -g generator-ui-component
```
4. Create a new directory and initialize a Git repo on it for your new ui-component:
```
mkdir your-project
cd your-project
git init
git remote add origin https://github.com/some-user/some-project.git
```
7. Run the generator:
```
yo ui-component
```
8. Answer the questions.
9. **STRONGLY RECOMMENDED:** commit the generated code to your git repository before making any modifications. This will make it much easier to see a diff of the work you have done vs. the generator output.
```
git add --all
git commit -m "Initial commit"
```
## Start writing your code
See the `README.md` file in your newly created ui-component for more information.
## Release versions
This repo uses [grunt-bump](https://github.com/gruntjs/grunt-bump) and Semantic Versioning to version and tag releases. To release a new version, run the appropriate command:
```
grunt release:major # bump major version, eg. 1.0.2 -> 2.0.0
grunt release:minor # bump minor version, eg. 0.1.3 -> 0.2.0
grunt release:patch # bump patch version, eg. 0.0.1 -> 0.0.2
grunt release:prerelease # bump pre-release version, eg. 1.0.0 -> 1.0.0-1
```
Make sure to push tags:
```
git push --tags origin master
```
Publish the package to [npm's public registry](https://www.npmjs.com/):
```
npm publish
```
To make sure everything worked just fine, go to [http://npmjs.com/package/generator-ui](http://npmjs.com/package/generator-ui).
**Heads up!** To publish, you must have a user on the npm registry. If you don't have one, create it with `npm adduser`. If you created one on the site, use `npm login` to store the credentials on the client. You can use `npm config ls` to ensure that the credentials are stored on your client. Check that it has been added to the registry by going to [http://npmjs.com/~](http://npmjs.com/~).
## Semantic Versioning
Given a version number `MAJOR.MINOR.PATCH`, increment the:
1. `MAJOR` version when you make incompatible API changes,
2. `MINOR` version when you add functionality in a backwards-compatible manner, and
3. `PATCH` version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the `MAJOR.MINOR.PATCH` format.
See the [Semantic Versioning](http://semver.org/) specification for more information.
## Release History
See the [CHANGELOG](CHANGELOG.md).