{"id":22486264,"url":"https://github.com/nuxt-contrib/opencollective","last_synced_at":"2025-05-13T12:54:44.422Z","repository":{"id":40246066,"uuid":"144468654","full_name":"nuxt-contrib/opencollective","owner":"nuxt-contrib","description":"🤝 Pretty opencollective stats on postinstall!","archived":false,"fork":false,"pushed_at":"2025-05-02T15:41:04.000Z","size":733,"stargazers_count":29,"open_issues_count":8,"forks_count":14,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-02T16:44:04.796Z","etag":null,"topics":["javascript","npm-script","nuxtjs","opencollective","postinstall","script","stats"],"latest_commit_sha":null,"homepage":"","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/nuxt-contrib.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-08-12T13:24:06.000Z","updated_at":"2025-03-24T20:10:36.000Z","dependencies_parsed_at":"2023-12-24T02:28:22.534Z","dependency_job_id":"b5aa314f-866e-4c9f-929b-4dfb23fc0611","html_url":"https://github.com/nuxt-contrib/opencollective","commit_stats":{"total_commits":67,"total_committers":11,"mean_commits":6.090909090909091,"dds":0.5970149253731343,"last_synced_commit":"01953a7ffdb85ab63feb45b7bf670bb7bab36018"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-contrib%2Fopencollective","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-contrib%2Fopencollective/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-contrib%2Fopencollective/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-contrib%2Fopencollective/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuxt-contrib","download_url":"https://codeload.github.com/nuxt-contrib/opencollective/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253948328,"owners_count":21988953,"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":["javascript","npm-script","nuxtjs","opencollective","postinstall","script","stats"],"created_at":"2024-12-06T17:14:14.069Z","updated_at":"2025-05-13T12:54:44.411Z","avatar_url":"https://github.com/nuxt-contrib.png","language":"JavaScript","funding_links":["https://opencollective.com/nuxtjs","https://opencollective.com/nuxtjs/logo.txt?reverse=true\u0026variant=variant2"],"categories":["JavaScript"],"sub_categories":[],"readme":"# @nuxtjs/opencollective 🤝 Pretty opencollective stats on postinstall!\n[![npm version][npm-v-src]][npm-v-href]\n[![npm downloads][npm-d-src]][npm-d-href]\n[![status][github-actions-src]][github-actions-href]\n\n![Showcase](https://i.imgur.com/PZqyT3x.jpg)\n\n\u003e\n\n[📖 **Release Notes**](./CHANGELOG.md)\n\n## Features\n\nDisplaying **opencollective** statistics and a donation URL after users install a package\nis important for many creators. After problems with current packages that offer similar\nfeatures, we decided to spin off our one own. Our key goals are:\n\n* No interference/problems when installing packages. Never break installation because of the package\n* Pretty output for all information\n* Decent configurability\n* Seamless drop-in for [common](https://github.com/opencollective/opencollective-cli) [solutions](https://github.com/opencollective/opencollective-postinstall)\n\n## Setup\n\n- Add `@nuxtjs/opencollective` dependency using yarn or npm to your project\n- Add the script to `postinstall` in your package.json\n\n```js\n{\n  // ...\n  \"scripts\": {\n    \"postinstall\": \"opencollective || exit 0\"\n  },\n  \"collective\": {\n    \"url\": \"https://opencollective.com/nuxtjs\"\n  }\n  // ...\n}\n```\n\n- Configure it\n\n## Configuration\n\nConfiguration is applied through your project's `package.json`.\n\nA full configuration looks like:\n\n```json\n{\n  \"collective\": {\n    \"url\": \"https://opencollective.com/nuxtjs\",\n    \"logoUrl\": \"https://opencollective.com/nuxtjs/logo.txt?reverse=true\u0026variant=variant2\",\n    \"donation\": {\n      \"slug\": \"/order/591\",\n      \"amount\": \"50\",\n      \"text\": \"Please donate:\"\n    }\n  }\n}\n```\n\n---\n\n| Attribute | Optional | Default | Comment |\n| ---    |   ---   | ---   | --- |\n| url | ❌  | - | The URL to your opencollective page\n| logo | ✅  | - | **LEGACY**: The URL to the logo that should be displayed. Please use `logoUrl` instead.\n| logoUrl | ✅  | - | The URL to the ASCII-logo that should be displayed.\n| donation.slug | ✅  | '/donate' | The slug that should be appended to `url`. Can be used to setup a specific order.\n| donation.amount | ✅  | - | The default amount that should be selected on the opencollective page.\n| donation.text | ✅  | 'Donate:' | The text that will be displayed before your donation url.\n\n## Disable message\n\nWe know the postinstall messages can be annoying when deploying in\nproduction or running a CI pipeline. That's why the message is\n**disabled** in those environments by default.\n\n**Enabled** when one the following environment variables is set:\n\n* `NODE_ENV=dev`\n* `NODE_ENV=development`\n* `OPENCOLLECTIVE_FORCE`\n\n**Strictly Disabled** when one the following environment variables is set:\n\n- `OC_POSTINSTALL_TEST`\n- `OPENCOLLECTIVE_HIDE`\n- `CI`\n- `CONTINUOUS_INTEGRATION`\n- `NODE_ENV` (set and **not** `dev` or `development`)\n- `DISABLE_OPENCOLLECTIVE` (set to any string value that is not `'false'` or `'0'`,\n  for compatibility with\n  [opencollective-postinstall](https://github.com/opencollective/opencollective-postinstall))\n\n## Development\n\n- Clone this repository\n- Install dependencies using `pnpm install`\n- Run it manually `path/to/project/root/src/index.js path/to/package/you/want/to/try`\n- Run tests with `npm t` or `pnpm test`\n\n## Inspiration\n\nThis project is heavily inspired by [opencollective-cli](https://github.com/opencollective/opencollective-cli).\n\n## License\n\n[MIT License](./LICENSE)\nMIT. Made with 💖\n\n\u003c!-- Refs --\u003e\n[npm-v-src]: https://img.shields.io/npm/v/@nuxtjs/opencollective?style=flat-square\n[npm-v-href]: https://npmjs.com/package/@nuxtjs/opencollective\n\n[npm-d-src]: https://img.shields.io/npm/dm/@nuxtjs/opencollective?style=flat-square\n[npm-d-href]: https://npmjs.com/package/@nuxtjs/opencollective\n\n[github-actions-src]: https://img.shields.io/github/workflow/status/nuxt-contrib/opencollective/ci/main?style=flat-square\n[github-actions-href]: https://github.com/nuxt-contrib/opencollective/actions?query=workflow%3Aci\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt-contrib%2Fopencollective","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuxt-contrib%2Fopencollective","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt-contrib%2Fopencollective/lists"}