https://github.com/bennycode/generator-toe
https://github.com/bennycode/generator-toe
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bennycode/generator-toe
- Owner: bennycode
- Created: 2015-10-27T16:21:42.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-01T22:10:50.000Z (about 9 years ago)
- Last Synced: 2025-03-09T11:02:17.267Z (4 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generator-toe
- Size: 128 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# generator-toe
[](https://travis-ci.org/bennyn/generator-toe)
`yo toe` is a generator for [Yeoman](http://yeoman.io) which creates a fantastic JavaScript project setup out-of-the-box including many features like code style checks, documentation generation, code coverage reports, minification and obfuscation and many more. Stay tuned for some videos which will show the benefits of this generator in detail.
## Getting Started
```bash
# Install Yeoman
npm install -g yo
# Install the "yo toe" generator
npm install -g generator-toe
# Create a directory for your project and switch to it
mkdir my-new-project
cd my-new-project
# Run the generator (inside your new project directory)
yo toe
```
## Development Pipeline
With `yo toe` you get a complete development pipeline out-of-the-box which includes the following Features...
### Initializing
`grunt init`
- Resolving dependencies (Dependency Management)
### Sanitizing
`grunt check`
- Code Style Checks (Linting)
- Checks for outdated comments
### Building
`grunt build`
- Transpilation of source code
- Transpilation of test code
- Transpilation of vendor files
- Transpilation of helper files
- Transpilation of stylesheets
### Testing
`grunt test`
- Unit testing (Specification Tests)
- In-Browser testing
- End-to-End testing
**Examples**
- `grunt test_specs_browser:Chrome`
- `grunt test_specs_browser:PhantomJS`
### Reporting
`grunt docs`
- Code Coverage (`grunt docs:coverage`)
- Code Documentation (`grunt docs:code`)
### Distributing
`grunt dist`
- Concatenation
- Minification
- Obfuscation
- Compression
- Source Map Generation
### Deploying
- *... coming soon*
### Updating
`grunt update`
- Update of node modules
### Supporting
- Project setup for NetBeans IDE 8+
- Project setup for WebStorm IDE 10+
- Support for Travis CI Environment
### Developing
`grunt dev`
- Development server
- File Watcher
- Live Reload