{"id":15560986,"url":"https://github.com/devopsmakers/gh-cards","last_synced_at":"2025-04-23T21:48:01.442Z","repository":{"id":56874096,"uuid":"220957627","full_name":"devopsmakers/gh-cards","owner":"devopsmakers","description":"Create HTML format cards from Github Issues for printing","archived":false,"fork":false,"pushed_at":"2019-11-19T15:06:47.000Z","size":47,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-23T21:47:53.637Z","etag":null,"topics":["agile","agile-board","cli","erb","gh-cards","github","github-issues","github-issues-export","html-format-cards","kanban-board","scrum","scrum-board"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/devopsmakers.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-11T10:36:47.000Z","updated_at":"2023-12-10T21:33:15.000Z","dependencies_parsed_at":"2022-08-20T10:11:02.555Z","dependency_job_id":null,"html_url":"https://github.com/devopsmakers/gh-cards","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devopsmakers%2Fgh-cards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devopsmakers%2Fgh-cards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devopsmakers%2Fgh-cards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devopsmakers%2Fgh-cards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devopsmakers","download_url":"https://codeload.github.com/devopsmakers/gh-cards/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250522297,"owners_count":21444510,"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":["agile","agile-board","cli","erb","gh-cards","github","github-issues","github-issues-export","html-format-cards","kanban-board","scrum","scrum-board"],"created_at":"2024-10-02T16:04:40.112Z","updated_at":"2025-04-23T21:48:01.398Z","avatar_url":"https://github.com/devopsmakers.png","language":"Ruby","readme":"# gh-cards\n\nCreate HTML format cards from Github Issues for printing\n\n![Default Cards for Printing](https://user-images.githubusercontent.com/57101177/68775712-e0e74c00-0626-11ea-8087-51bb9e7cdfeb.png)\n\n\n## Installation\n\n```\ngem install gh-cards\n```\n\n### Pre-requisites\n\n1. Create a Github Personal Access Token with **repo** access - https://github.com/settings/tokens/new\n\n2. Configure your `~/.netrc` file with:\n```\nmachine api.github.com login \u003c\u003cusername\u003e\u003e password \u003c\u003caccess-token\u003e\u003e\n```\nand set it's permissions: `chmod 0600 ~/.netrc`\n\n## Usage\n\nThe `gh-cards` cli tool is designed to be run inside a repo. It will create a\ndirectory `.gh-cards` containing a file named `last` which stores the last card\nand a file `cards.html` which are the cards to be printed.\n\nAt least the `.gh-cards/last` file should be committed to your repo so that anyone\ncan print cards as necessary.\n\nTo generate cards from all open issues, `rm .gh-cards/last`.\n\n```\nCommands:\n  gh-cards generate        # Generate your Github issue cards HTML file\n  gh-cards help [COMMAND]  # Describe available commands or one specific command\n\nOptions:\n  -t, [--template=TEMPLATE]    # Template name or path to erb template\n                               # Default: default\n  -d, [--directory=DIRECTORY]  # The directory to use for output\n                               # Default: .gh-cards\n  -r, [--repo=REPO]            # The org/repo you want to generate cards for (autodetected when inside a repo)\n```\n\nTo generate cards:\n```\ncd my-repo\ngh-cards generate\n```\n\n## Card Templates\n\nCards are generated using ERB Templates. The default template is in this repo\nat: `templates/default.html.erb` which is designed to use minimal ink. If templates\nare added in the future (Hint: open PRs) you'll be able to reference them with\nthe `-t` or `--template` option.\n\nYou can also create your own templates, for example if you create a template at:\n`.gh-cards/my-template.html.erb` you can generate cards using your template:\n```\ngh-cards generate --template=.gh-cards/my-template.html.erb\n```\n\nThe cards passed to the ERB are an array of objects:\n```\n[\n  {\n    :title=\u003e\"Test Issue\",\n    :number=\u003e1,\n    :labels=\u003e[\n      {\n        :name=\u003e\"bug\",\n        :color=\u003e\"d73a4a\"\n      },\n      {\n        :name=\u003e\"good first issue\",\n        :color=\u003e\"7057ff\"\n      },\n      {\n        :name=\u003e\"help wanted\",\n        :color=\u003e\"008672\"\n      }\n    ],\n    :milestone=\u003e\"Test Milestone\",\n    :created_by=\u003e\"Tim Birkett\",\n    :created_at=\u003e2019-11-07 15:07:31 UTC\n  },\n  ...\n  ...\n  ...\n]\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/devopsmakers/gh-cards. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the Gh::Cards project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/devopsmakers/gh-cards/blob/master/CODE_OF_CONDUCT.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevopsmakers%2Fgh-cards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevopsmakers%2Fgh-cards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevopsmakers%2Fgh-cards/lists"}