What am I?
Yeoman is a robust and opinionated client-side stack, comprised of tools and frameworks that can help developers quickly build beautiful web applications. We take care of providing everything needed to get started without any of the normal headaches associated with a manual setup.
Yeoman is fast, performant and is optimized to work best in modern browsers.
For more information about the project, see yeoman.io.
- Clone this repo and
- Run this command:
- Navigate to a new directory and run
yeoman initto make sure everything is working as expected.
Yeoman supports a powerful set of high-level commands. These include:
yeoman init # Initialize and scaffold a new project using generator templates yeoman build # Build an optimized version of your app, ready to deploy yeoman server # Launch a preview server which will begin watching for changes yeoman test # Run a Mocha test harness in a headless Phantom.js yeoman install # Install a package from the client-side package registry yeoman uninstall # Uninstall the package yeoman update # Update a package to the latest version yeoman list # List the packages currently installed yeoman search # Query the registry for matching package names yeoman lookup # Look up info on a particular package
A common initial workflow with Yeoman might be:
yeoman init # Invoke the most basic application scaffold (Bootstrap, Boilerplate etc.) yeoman build # Build your project, creating an optimized version in the publish folder yeoman server # Create an intermediate version of your app, firing off a watch process
Some more examples of how to use our commands include:
yeoman init angular:bootstrap # Invoke the AngularJS generator scaffold yeoman init angular:controller # Invoke the AngularJS Controller sub-generator yeoman install jquery underscore [depName] # Install a dependency or dependencies yeoman update jquery # Update a specific dependency (e.g jquery) yeoman search jquery # Lookup jquery in the Bower registry
If for any reason you experience exceptions after the yeoman installation process above, you may find the following steps resolve these issues:
cd yeoman/cli sudo -s 'npm install -g && npm link'
Here's a small shell script that you can save as
server.sh which opens and serves the current directory:
#!/usr/bin/env sh port=$1 if [ $# -ne 1 ]; then port=8000 fi if [ $(uname -s) == "Darwin" ]; then open=open else open=xdg-open fi $open http://localhost:$port && python -m SimpleHTTPServer $port;
You then need to make it executable:
$ chmod +x server.sh
For example, run this guy as
$ server (defaults to port 8000), or supply a port yourself
$ server 3000.
- Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)
- Chrome on Android
- Mobile Safari
Yeoman 1.0 will support OS X and will attempt to support Linux as well. We will be aiming to bring in support for Windows in a future version of the project.
This project follows the jQuery Style Guide with an exception of two space indentation and multiple var statements. Please ensure any pull requests follow this closely. If you notice existing code which doesn't follow these practices, feel free to shout and we will address this.
Pull Request Guidelines
- Lint the code by running
/clifolder before submitting a pull request
- Develop in a topic branch, not master
Yeoman has a test suite to ensure it's reliably and accurately working as a developer tool. You can find the main test suite in
test/test-build.js, most of the assertions are checks against yeoman cli stdout.
To run our test suite:
Do note that if any CLI prompts are not accounted for the test suite will have a timeout failure.
We have significant developer docs for you if you'd like to hack on Yeoman.
You're also welcome to
git blame back to commit messages and pull requests. As a project we value comprehensive discussion for our fellow developers.
- Twitter Bootstrap
- HTML5 Boilerplate
- Twitter Bower
- And more...
Version 1 of the project features the combined efforts of:
and other developers.
We will be aiming to officially release the project in late July, 2012.