0.1.0 • Published 10 years ago

generator-jsproject v0.1.0

Weekly downloads
5
License
MIT
Repository
github
Last release
10 years ago

generator-jsproject Build Status

Yeoman generator for javascript projects, because having to copy over files every time is a pain.

What does it do?

  • Initialize core files that are generally used in all my javascript projects
  • Creates the folder for you unless you opt-out
  • Creates the GitHub repo for you unless you opt-out (requires GITHUB_TOKEN)

Usage

Make sure you have Yeoman installed:

$ npm install -g yo

Install generator-jsproject:

$ npm install -g generator-jsproject

Finally, initiate the generator:

$ yo jsproject

If during generation you get an error like API rate limit exceeded, you need to log in to GitHub and create a new API token, then add:

export GITHUB_TOKEN='YOUR_NEW_TOKEN'

to your .bashrc, .zshrc, .profile or another file that is run on shell initialization. In new terminal shells you shouldn't see this error anymore.

Environment Variables

  • GITHUB_USERNAME - value that will be used as the default GitHub username, defaults to cesarandreu
  • GITHUB_TOKEN - your github token, must have public_repo or repo permissions to initialize your GitHub repo

Generated files

  • bower.json
  • package.json
  • LICENSE (MIT)
  • README.md
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .jshintrc
  • .travis.yml

License

MIT