{"id":25198495,"url":"https://github.com/jordanopensource/nuxt-build-banner","last_synced_at":"2025-05-09T00:55:25.809Z","repository":{"id":63592370,"uuid":"567267214","full_name":"jordanopensource/nuxt-build-banner","owner":"jordanopensource","description":"A Nuxt 3 module to display build information","archived":false,"fork":false,"pushed_at":"2025-01-22T01:24:04.000Z","size":659,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-05-09T00:55:17.548Z","etag":null,"topics":["build","environment","npm-module","npm-package","nuxt","nuxt-module","nuxtjs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@josango/nuxt3-build-banner","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jordanopensource.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-17T12:37:46.000Z","updated_at":"2023-09-03T11:35:52.000Z","dependencies_parsed_at":"2023-12-19T01:01:53.338Z","dependency_job_id":"c658cace-46ac-4f62-887f-920e67c10f8b","html_url":"https://github.com/jordanopensource/nuxt-build-banner","commit_stats":{"total_commits":19,"total_committers":3,"mean_commits":6.333333333333333,"dds":"0.26315789473684215","last_synced_commit":"471f38fc2f6d04886f20276ab1c17482e5b119a3"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordanopensource%2Fnuxt-build-banner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordanopensource%2Fnuxt-build-banner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordanopensource%2Fnuxt-build-banner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jordanopensource%2Fnuxt-build-banner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jordanopensource","download_url":"https://codeload.github.com/jordanopensource/nuxt-build-banner/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253171251,"owners_count":21865290,"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":["build","environment","npm-module","npm-package","nuxt","nuxt-module","nuxtjs"],"created_at":"2025-02-10T03:17:16.759Z","updated_at":"2025-05-09T00:55:25.779Z","avatar_url":"https://github.com/jordanopensource.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JOSA Build info banner\n\nThis is a Nuxt3 module for our banner that displays the Drone build info that are injected into the build args of the docker image during build time in the pipline.\n\n## Usage\n\nnpm install the package\n\n```bash\n# using npm\nnpm i --save-dev @josango/nuxt3-build-banner\n\n# Using pnpm\npnpm add -D @josango/nuxt3-build-banner\n```\n\nAnd Load it into your `nuxt.config.ts` modules:\n\n```js\n  export default defineNuxtConfig({\n  ...\n  modules: [\n    '@josango/nuxt-build-banner',\n  ],\n  ....\n})\n```\n\nAdd the following as environmental variables in `.env`\n\n```env\nNUXT_PUBLIC_TARGET_ENV=\nNUXT_PUBLIC_BUILD_COMMIT_SHA=\nNUXT_PUBLIC_BUILD_NUMBER=\nNUXT_PUBLIC_BUILD_LINK=\nNUXT_PUBLIC_BUILD_COMMIT_LINK=\nNUXT_PUBLIC_BUILD_REPO_LINK=\nNUXT_PUBLIC_BUILD_TIMESTAMP=\n```\n\nMake sure to pass them in `nuxt.config.ts` as public runtime config\n\n```js\nexport default defineNuxtConfig({\n  ...\n  runtimeConfig: {\n    public: {\n      targetEnv: \"\",\n      buildCommitSha: \"\",\n      buildCommitLink: \"\",\n      buildNumber: \"\",\n      buildLink: \"\",\n      buildRepoLink: \"\",\n      buildTimestamp: \"\",\n    },\n  },\n  ...\n})\n```\n\nLast thing load the module inside your default layout page, or where ever you want to display it.\n\n```jsx\n\u003cbuildInfoBanner /\u003e\n```\n\nIf you want to display it only when development mode is enabled\n\n```jsx\n\u003cbuildInfoBanner v-if=\"useRuntimeConfig().public.targetEnv==='development'\" /\u003e\n```\n\n## Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Generate type stubs\nnpm run dev:prepare\n\n# Develop with the playground\nnpm run dev\n\n# Build the playground\nnpm run dev:build\n\n# Run ESLint\nnpm run lint\n\n# Release new version\nnpm run release\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjordanopensource%2Fnuxt-build-banner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjordanopensource%2Fnuxt-build-banner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjordanopensource%2Fnuxt-build-banner/lists"}