{"id":47804305,"url":"https://github.com/xarlizard/react-responsive-package","last_synced_at":"2026-04-03T17:25:48.584Z","repository":{"id":344166595,"uuid":"1132318454","full_name":"xarlizard/react-responsive-package","owner":"xarlizard","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-13T11:21:57.000Z","size":567,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-13T23:37:08.551Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/xarlizard.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-11T18:28:48.000Z","updated_at":"2026-03-13T11:21:55.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/xarlizard/react-responsive-package","commit_stats":null,"previous_names":["xarlizard/react-responsive-package"],"tags_count":null,"template":false,"template_full_name":"xarlizard/npm-package-template","purl":"pkg:github/xarlizard/react-responsive-package","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlizard%2Freact-responsive-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlizard%2Freact-responsive-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlizard%2Freact-responsive-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlizard%2Freact-responsive-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xarlizard","download_url":"https://codeload.github.com/xarlizard/react-responsive-package/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlizard%2Freact-responsive-package/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31365910,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T17:13:05.644Z","status":"ssl_error","status_checked_at":"2026-04-03T17:13:04.413Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-04-03T17:25:47.835Z","updated_at":"2026-04-03T17:25:48.564Z","avatar_url":"https://github.com/xarlizard.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NPM Package Template 📦\n\n[![npm version](https://badge.fury.io/js/@xarlizard%2Fnpm-package-template.svg)](https://badge.fury.io/js/@xarlizard%2Fnpm-package-template)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)\n[![CI/CD](https://github.com/xarlizard/npm-package-template/actions/workflows/publish.yml/badge.svg)](https://github.com/xarlizard/npm-package-template/actions/workflows/publish.yml)\n[![Production Deployment](https://github.com/xarlizard/npm-package-template/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/xarlizard/npm-package-template/actions/workflows/deploy.yml)\n[![Coverage](https://codecov.io/gh/xarlizard/npm-package-template/branch/main/graph/badge.svg)](https://codecov.io/gh/xarlizard/npm-package-template)\n\nA comprehensive, production-ready TypeScript npm package template with automated publishing, testing, and modern\ntooling.\n\n\u003e **⚡ Quick Start**: Click \"Use this template\" above to create your own npm package in seconds!\n\n---\n\n## ✨ Features\n\n- **TypeScript Support**: Full TypeScript setup with declaration files\n- **Modern Build System**: Rollup for optimized bundling (ESM + CJS)\n- **Automated Testing**: Jest with coverage reporting\n- **Code Quality**: ESLint with TypeScript support\n- **Automated Publishing**: GitHub Actions for NPM and GitHub Packages (using Trusted Publishing)\n- **Cross-Platform Scripts**: PowerShell and Node.js scripts\n- **Security**: Security policy and vulnerability reporting\n- **Documentation**: Comprehensive docs and examples\n- **Dual Registry Support**: Publish to both NPM and GitHub Packages\n\n---\n\n## 📦 Using This Template\n\n### Method 1: Use as GitHub Template\n\n1. Click \"Use this template\" button on GitHub\n2. Create your new repository\n3. Clone and customize\n\n### Method 2: Clone and Customize\n\n```bash\ngit clone https://github.com/xarlizard/npm-package-template.git my-package\ncd my-package\nnpm install\n```\n\n### Method 3: Install as Reference\n\n```bash\nnpm install @xarlizard/npm-package-template --save-dev\n```\n\n\u003e **ℹ️ Missing files**: By donwloading it directly as an npm-package, you will miss out on a lot of files, be sure to\n\u003e check the official github URL to see all available ones!\n\n## 📚 Repository File Reference\n\nThis section explains the purpose of every file and folder in this repository, so you know exactly what each part does.\n\n### Root Files\n\n```\n├── .github/workflows/     # GitHub Actions\n├── dist/                  # Built files (generated)\n├── docs/                  # Documentation files\n├── examples/              # Usage examples\n├── scripts/               # Build and release scripts\n│   ├── dev.ps1            # Development tasks (PowerShell)\n│   ├── release.ps1        # Release script (PowerShell)\n│   └── release.js         # Release script (Node.js)\n├── src/                   # Source code\n│   ├── __tests__/         # Test files\n│   ├── index.ts           # Main entry point\n│   ├── types.ts           # Type definitions\n│   └── utils.ts           # Utility functions\n├── templates/             # Template files with blank fields\n├── .eslintrc.json         # ESLint configuration.\n├── .gitignore             # Git ignore patterns.\n├── .npmignore             # Files to exclude from NPM package.\n├── .npmrc                 # NPM and GitHub Packages registry configuration.\n├── .prettierignore        # Prettier ignore patterns.\n├── .prettierrc.json       # Prettier configuration.\n├── CHANGELOG.md           # Project change history.\n├── CODE_OF_CONDUCT.md     # Contributor Covenant code of conduct.\n├── CONTRIBUTING.md        # Contribution guidelines.\n├── jest.config.json       # Jest testing configuration.\n├── LICENSE                # MIT License.\n├── package.json           # NPM package configuration.\n├── README.md:             # Main project overview and file reference.\n├── rollup.config.js       # Rollup build configuration.\n├── SECURITY.md            # Security policy and vulnerability reporting.\n└── tsconfig.json          # TypeScript configuration.\n```\n\n### Documentation (`docs/`)\n\n- [**DEPENDABOT.md**](./docs/DEPENDABOT.md): Automated dependency updates via `.github/dependabot.yml`.\n- [**ISSUE_TEMPLATES.md**](./docs/ISSUE_TEMPLATES.md): Issue templates in `.github/ISSUE_TEMPLATE/`.\n- [**PULL_REQUEST_TEMPLATE.md**](./docs/PULL_REQUEST_TEMPLATE.md): Pull request template in\n  `.github/pull_request_template.md`.\n- [**TEMPLATE_SETUP.md**](./docs/TEMPLATE_SETUP.md): Step-by-step guide for customizing this template.\n- [**WORKFLOWS.md**](./docs/WORKFLOWS.md): Details all GitHub Actions workflows in `.github/workflows/`.\n\n### Source Code (`src/`)\n\n- **index.ts**: Main entry point for the package.\n- **types.ts**: TypeScript types and interfaces.\n- **utils.ts**: Utility functions.\n- \\***\\*tests**/\\*\\*: Unit tests for main functions and utilities.\n\n### Examples (`examples/`)\n\n- **README.md**: Usage examples overview.\n- **basic-usage.js**: Node.js usage example.\n- **typescript-usage.ts**: TypeScript usage example.\n\n### Scripts (`scripts/`)\n\n- **dev.ps1**: PowerShell script for development tasks.\n- **release.js**: Node.js script for automated release.\n- **release.ps1**: PowerShell script for publishing releases.\n- **setup.js**: Node.js script for initial setup and validation.\n\n### GitHub Configuration (`.github/`)\n\n- **dependabot.yml**: Dependabot configuration.\n- **pull_request_template.md**: Pull request template.\n- **ISSUE_TEMPLATE/**: Issue templates for bug reports, documentation, and features.\n- **workflows/**: GitHub Actions workflows for CI, publishing, and security.\n\n---\n\n## 🛠️ Setup \u0026 Customization\n\nSee [`docs/TEMPLATE_SETUP.md`](docs/TEMPLATE_SETUP.md) for a step-by-step guide to customizing this template for your\nown package, including updating `package.json`, configuring secrets, and setting up your code.\n\n---\n\n## 🎯 Quick Start Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Development with all checks\nnpm run dev\n\n# Individual tasks\nnpm run dev:build    # Build only\nnpm run dev:test     # Test only\nnpm run dev:lint     # Lint only\nnpm run dev:typecheck # Type check only\n\n# Testing\nnpm run test\nnpm run test:watch\nnpm run test:coverage\n\n# Building\nnpm run build\n\n# Releasing\nnpm run release        # Patch version\nnpm run release:minor  # Minor version\nnpm run release:major  # Major version\n```\n\n---\n\n## 🔧 Available Scripts\n\n| Script                  | Description               |\n| ----------------------- | ------------------------- |\n| `npm run build`         | Build the package         |\n| `npm run test`          | Run tests                 |\n| `npm run test:watch`    | Run tests in watch mode   |\n| `npm run test:coverage` | Run tests with coverage   |\n| `npm run lint`          | Lint code                 |\n| `npm run lint:fix`      | Fix linting issues        |\n| `npm run typecheck`     | Type check code           |\n| `npm run dev`           | Run all development tasks |\n| `npm run release`       | Release patch version     |\n| `npm run release:minor` | Release minor version     |\n| `npm run release:major` | Release major version     |\n\n---\n\n## 🚀 Publishing\n\n### Automated Publishing (Recommended)\n\nThis template uses a **hybrid authentication approach**:\n- **Primary:** npm Trusted Publishing (OIDC) - secure, no tokens needed\n- **Fallback:** NPM_TOKEN secret - automatic fallback if Trusted Publishing fails\n\n**Setup (choose one):**\n\n**Option 1: Trusted Publishing (Recommended)**\n1. Enable Trusted Publishing in your npm account settings\n2. Link your GitHub repository to npm\n3. No secrets needed!\n\n**Option 2: NPM_TOKEN (Fallback)**\n1. Generate an npm access token\n2. Add `NPM_TOKEN` secret to your repository\n\n**Publishing:**\n1. Create a GitHub release\n2. GitHub Actions will automatically:\n   - Run tests\n   - Build the package\n   - Publish to NPM (tries Trusted Publishing first, falls back to NPM_TOKEN if needed)\n   - Publish to GitHub Packages\n\nSee [`docs/TEMPLATE_SETUP.md`](docs/TEMPLATE_SETUP.md) for detailed setup instructions.\n\n### Manual Publishing\n\n```bash\n# Publish to NPM (requires npm login first)\nnpm login\nnpm publish\n\n# Publish to GitHub Packages\nnpm config set @YOUR_USERNAME:registry https://npm.pkg.github.com\nnpm publish\n```\n\n---\n\n## 🤝 Contributing to This Template\n\nWe welcome contributions! See [`CONTRIBUTING.md`](CONTRIBUTING.md) for guidelines.\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Add tests if applicable\n5. Submit a pull request\n\n---\n\n## 📄 License\n\nThis template is licensed under the MIT License - see the [`LICENSE`](LICENSE) file for details.\n\n---\n\n## 🙏 Acknowledgments\n\nIncludes best practices from:\n\n- TypeScript team recommendations\n- NPM packaging guidelines\n- GitHub Actions community\n- Open source community standards\n\n---\n\n**Happy packaging! 📦✨**\n\nMade with ❤️ by [Xarlizard](https://www.github.com/xarlizard)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxarlizard%2Freact-responsive-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxarlizard%2Freact-responsive-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxarlizard%2Freact-responsive-package/lists"}