{"id":16226801,"url":"https://github.com/c0bra/generator-ui-grid-plugin","last_synced_at":"2025-03-19T13:30:49.194Z","repository":{"id":29459595,"uuid":"32996027","full_name":"c0bra/generator-ui-grid-plugin","owner":"c0bra","description":"Yeoman generator for Angular UI-Grid plugins","archived":false,"fork":false,"pushed_at":"2017-01-24T15:11:48.000Z","size":1511,"stargazers_count":5,"open_issues_count":4,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-28T18:47:40.436Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://c0bra.github.io/generator-ui-grid-plugin","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/c0bra.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-27T16:08:13.000Z","updated_at":"2017-08-09T23:02:21.000Z","dependencies_parsed_at":"2022-08-24T16:30:14.027Z","dependency_job_id":null,"html_url":"https://github.com/c0bra/generator-ui-grid-plugin","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c0bra%2Fgenerator-ui-grid-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c0bra%2Fgenerator-ui-grid-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c0bra%2Fgenerator-ui-grid-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/c0bra%2Fgenerator-ui-grid-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/c0bra","download_url":"https://codeload.github.com/c0bra/generator-ui-grid-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243989729,"owners_count":20379648,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T12:50:31.082Z","updated_at":"2025-03-19T13:30:48.890Z","avatar_url":"https://github.com/c0bra.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UI-Grid Plugin Generator\n\n\u003c!-- [![Travis](https://img.shields.io/travis/c0bra/generator-ui-grid-plugin.svg)](https://travis-ci.org/c0bra/generator-ui-grid-plugin) [![devDependencies](https://img.shields.io/david/dev/c0bra/generator-ui-grid-plugin.svg?style=flat)](https://david-dm.org/c0bra/ui-grid-plugin-skeleton#info=devDependencies) [![Coveralls](https://img.shields.io/coveralls/c0bra/generator-ui-grid-plugin.svg?style=flat)](https://coveralls.io/r/c0bra/generator-ui-grid-plugin) --\u003e\n\nThis repo is a Yeoman generator for [UI-Grid](http://ui-grid.info) plugins.\n\n![Screenshot](http://brianhann.com/wp-content/uploads/2015/04/ui-grid-plugin-generator.png)\n\n# What You Get\n\n* Standard Angular project build cycle, with jshint, jsrc, ngAnnotate, and lesscss\n* Automated tests with Karma\n* ~~Automated e2e tests with Protractor~~\n* Automated docs generation with Dgeni\n* Development environment based on your docs: use examples to demonstrate and test functionality.\n* Automated publishing with gh-pages: use your generated docs files to create your plugin's website.\n\n# Get Started\n\nInstall yeoman if you don't already have it, and the plugin generator:\n\n    npm install -g yo generator-ui-grid-plugin\n\nCreate your plugin folder and bootstrap the plugin\n\n    mkdir my-plugin\n    cd my-plugin\n    yo ui-grid-plugin\n\nFollow the prompts. The generator will ask you for your plugin's name, its description, and blah. Wait for all the dependencies to be installed, then you can get started.\n\n# Run it!\n    \nYou can start up a development task like so. It will run on port 4000. If you want another port there's a switch for that.\n\n    gulp watch\n    gulp watch --port 9999\n\n# Writing Your Plugin\n\n* All the .js files in src/ will be concatenated together and ngAnnotated.\n* Tests in test/ will be run with karma.\n* You can add tutorials by putting .md files in `docs/content/`. They use markdown and @ngdoc formatting.\n* You can add whatever other dependencies you need, from npm or bower.\n\n# Caveats\n\n* The JSHint and JSCS config follows the same practices that UI-Grid does (or at least UI-Grid tries to). It's kind of strict, so if you want to make modifications feel free.\n\n# Badges\n\nThere's a generator for adding badge/shield images to the top of your README.md Just run this and select the options you want (you'll need to have your repository set in package.json):\n\n    yo ui-grid-plugin:badges\n\n## Coveralls\n\nOne of the badges is for Coveralls, and you'll need to sign up at http://coveralls.io if you want to use it. It's a great free, automated test coverage tool.\n\n# Development\n\n## Protractor\n\n**Note:** Protractor tests do not work, currently. They throw a \"window is not defined\" error, which isn't documented well anywhere that I can find.\n\n## Publish\n\nThe `publish` task takes automatically generated docs and dist files and push them to the gh-pages branch.\n\n    gulp publish --tag v0.0.1\n\nTravis will also publish to gh-pages. You will need to set the version in `bower.json` and `package.json`. A gulp-bump task is included to make it easier. Here's some examples:\n\n    gulp bump --version 1.0.1\n    gulp bump --type minor\n    gulp bump --type patch\n\nCommit and then push to GitHub. Travis will pick up the commit, create a tag for the new version, and push the updates to you gh-pages branch.\n\n## Travis\n\nIn order for Travis to publish your generated content to your gh-pages branch on GitHub, you need to give it a secure token it can use. First you'll need to make sure you've set up your GitHub repo if you haven't already:\n\n    git remote add origin https://github.com/yourname/your-repo.git\n\nThen for encrypting your secure token Travis has a ruby gem that can do it:\n\n    gem install travis\n\n    travis login\n    # enter your login info\n\n    travis encrypt GITHUB_TOKEN=youtokenhere\n\nIt will print out the encrypted string. It's important to make sure you use `GITHUB_TOKEN` as the name and that you're in your project folder.\n\nYou can run this generator to add it:\n\n    yo ui-grid-plugin:travis\n\nIt will prompt you for the encrypted string, and will store it in your `.travis.yml` file. Be sure to paste *just* the encrypted string and not the `secure: ` prefix or the double quotes around the string.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc0bra%2Fgenerator-ui-grid-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fc0bra%2Fgenerator-ui-grid-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fc0bra%2Fgenerator-ui-grid-plugin/lists"}