{"id":51451200,"url":"https://github.com/czfabrics/front-ready","last_synced_at":"2026-07-22T05:00:52.819Z","repository":{"id":362657624,"uuid":"1259488559","full_name":"czfabrics/front-ready","owner":"czfabrics","description":"A framework-aware deployment tool for static frontends. It reads your project's build configuration (e.g. angular.json), runs the build with the configuration you choose, and pushes the compiled output to an S3 bucket — with correct content types and cache headers — so a single command takes you from source to a live, hosted site.","archived":false,"fork":false,"pushed_at":"2026-07-03T13:52:36.000Z","size":203,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2026-07-03T15:28:43.127Z","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/czfabrics.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-04T14:59:16.000Z","updated_at":"2026-07-03T13:52:40.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/czfabrics/front-ready","commit_stats":null,"previous_names":["czfabrics/front-ready"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/czfabrics/front-ready","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czfabrics%2Ffront-ready","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czfabrics%2Ffront-ready/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czfabrics%2Ffront-ready/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czfabrics%2Ffront-ready/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/czfabrics","download_url":"https://codeload.github.com/czfabrics/front-ready/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czfabrics%2Ffront-ready/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35748424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-22T02:00:06.236Z","response_time":124,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-07-05T21:00:27.979Z","updated_at":"2026-07-22T05:00:52.808Z","avatar_url":"https://github.com/czfabrics.png","language":"TypeScript","funding_links":[],"categories":["Angular"],"sub_categories":["Deployment"],"readme":"\u003c!-- ⚠️ This README has been generated from the file(s) \".blueprint.md\" ⚠️--\u003e\u003ch1 align=\"center\"\u003e@czfabrics/front-ready\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n\t\t\u003ca href=\"https://npmcharts.com/compare/@czfabrics/front-ready?minimal=true\"\u003e\u003cimg alt=\"Downloads per month\" src=\"https://img.shields.io/npm/dm/@czfabrics/front-ready.svg\" height=\"20\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/@czfabrics/front-ready\"\u003e\u003cimg alt=\"NPM Version\" src=\"https://img.shields.io/npm/v/@czfabrics/front-ready.svg\" height=\"20\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/czfabrics/front-ready/graphs/commit-activity\"\u003e\u003cimg alt=\"Maintained\" src=\"https://img.shields.io/badge/Maintained%3F-yes-green.svg\" height=\"20\"/\u003e\u003c/a\u003e\n\t\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003eA framework-aware deployment tool for static frontends. It reads your project's build configuration (e.g. angular.json), runs the build with the configuration you choose, and pushes the compiled output to an S3 bucket — with correct content types and cache headers — so a single command takes you from source to a live, hosted site.\u003c/b\u003e\u003c/br\u003e\n  \u003csub\u003e\u003csub\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n\n[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/dark.png)](#table-of-contents)\n\n## Table of Contents\n\n* [Overview](#overview)\n\t* [Key Features](#key-features)\n* [Installation](#installation)\n\t* [Bun](#bun)\n\t* [Yarn](#yarn)\n\t* [NPM](#npm)\n* [Quick Start](#quick-start)\n\t* [Configuration](#configuration)\n\t* [Commands](#commands)\n* [Configuration](#configuration-1)\n\t* [Custom front](#custom-front)\n\t* [Angular front](#angular-front)\n\t* [Cache control](#cache-control)\n* [Commands](#commands-1)\n\t* [Create](#create)\n\t* [Check](#check)\n\t* [Deploy](#deploy)\n* [License](#license)\n\n[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/dark.png)](#overview)\n\n## Overview\n\nA framework-aware deployment tool for static frontends. It reads your project's build configuration (e.g. angular.json), runs the build with the configuration you choose, and pushes the compiled output to an S3 bucket — with correct content types and cache headers — so a single command takes you from source to a live, hosted site.\n\n### Key Features\n\n- **S3 Bucket support**: Upload your frontend files to an S3 bucket.\n- **S3 Bucket host agnostic**: Choose the host you want (Amazon, OVH, etc.).\n- **Angular support**: It reads your `angular.json` to know how to build and which folder is the output build folder.\n- **Any Front support**: Adaptable to any frontend by using the `custom` config.\n\n\n[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/dark.png)](#installation)\n\n## Installation\n\n### Bun\n\n```sh\nbun add @czfabrics/front-ready@0.1.0-beta.4\n```\n\n### Yarn\n\n```sh\nyarn add @czfabrics/front-ready@0.1.0-beta.4\n```\n\n### NPM\n\n```sh\nnpm install @czfabrics/front-ready@0.1.0-beta.4\n```\n\n\n[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/dark.png)](#quick-start)\n\n## Quick Start\n\n### Configuration\n\nCreate a `frontready.config.ts` file at the root of your project:\n\n```ts\nimport { Config } from '@czfabrics/front-ready'\n\nexport default {\n  bucket: {\n    namePrefix: 'my-front-hosting',\n    params: {\n      region: 'eu-west-3',\n      apiVersion: '2006-03-01',\n      endpoint: 'https://s3.eu-west-3.amazonaws.com',\n      credentials: {\n        accessKeyId: 'AKIAIOSFODNN7EXAMPLE',\n        secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',\n      },\n    },\n  },\n  front: {\n    type: 'custom',\n    custom: {\n      build: {\n        command: 'npx ng build',\n        args: ['--configuration', 'production'],\n      },\n      environmentName: 'production',\n      buildOutputPath: './example',\n    },\n  },\n} satisfies Config\n```\n\n\u003e **Tip:** Don't commit real credentials. Load `accessKeyId` and `secretAccessKey` from environment variables instead.\n\n### Commands\n\n**1. Create the bucket**\n\n```sh\nnpx @czfabrics/front-ready create\n```\n\n**2. Build and deploy your frontend**\n\n```sh\nnpx @czfabrics/front-ready deploy\n```\n\n\n[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/dark.png)](#configuration)\n\n## Configuration\n\nCreate a `frontready.config.ts` file at the root of your project. The shape of the `front` key depends on how your frontend is built.\n\n### Custom front\n\nUse `type: 'custom'` when you want to define the build command yourself.\n\n```ts\nimport { Config } from '@czfabrics/front-ready'\n\nexport default {\n  bucket: {\n    namePrefix: 'my-front-hosting',\n    params: {\n      region: 'eu-west-3',\n      apiVersion: '2006-03-01',\n      endpoint: 'https://s3.eu-west-3.amazonaws.com',\n      credentials: {\n        accessKeyId: 'AKIAIOSFODNN7EXAMPLE',\n        secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',\n      },\n    },\n  },\n  front: {\n    type: 'custom',\n    custom: {\n      build: {\n        command: 'npx ng build',\n        args: ['--configuration', 'production'],\n      },\n      environmentName: 'production',\n      buildOutputPath: './example',\n    },\n  },\n} satisfies Config\n```\n\n### Angular front\n\nUse `type: 'angular'` to let `frontready` read your build settings straight from `angular.json`.\n\n```ts\nimport { Config } from '@czfabrics/front-ready'\n\nexport default {\n  bucket: {\n    namePrefix: 'my-front-hosting',\n    params: {\n      region: 'eu-west-3',\n      apiVersion: '2006-03-01',\n      endpoint: 'https://s3.eu-west-3.amazonaws.com',\n      credentials: {\n        accessKeyId: 'AKIAIOSFODNN7EXAMPLE',\n        secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',\n      },\n    },\n  },\n  front: {\n    type: 'angular',\n    angular: {\n      angularJsonPath: './angular.json',\n      projectName: 'MyFront',\n      configurationName: 'production',\n    },\n  },\n} satisfies Config\n```\n\n\u003e **Tip:** Don't hardcode real credentials. Load `accessKeyId` and `secretAccessKey` from environment variables instead.\n\n### Cache control\n\nThe default cache configuration assumes your build emits **content-hashed (randomly named) chunk files** — the standard cache-busting pattern where a file's name changes whenever its contents change. This lets hashed assets be cached aggressively while the entry point stays fresh.\n\nIf your build tool doesn't hash filenames this way, override `defaultCacheControlValue` (and `cacheControlMapping`) so you don't serve stale assets:\n\n```ts\nimport { Config } from '@czfabrics/front-ready'\n\nexport default {\n  bucket: {\n    front: {\n      defaultCacheControlValue:\n        'max-age=60, stale-while-revalidate=600, stale-if-error=86400',\n      cacheControlMapping: {\n        '^index.html$': 'max-age=60, stale-while-revalidate=600, stale-if-error=86400',\n        '^assets/.+$': 'max-age=86400, stale-while-revalidate=600, stale-if-error=86400',\n        '^translate/.+$':\n          'max-age=14400, stale-while-revalidate=600, stale-if-error=86400',\n        '^.+$': 'max-age=31536000, stale-while-revalidate=600, stale-if-error=86400',\n      },\n      indexDocumentSuffix: 'index.html',\n      errorDocumentKey: 'index.html',\n    },\n    upload: {\n      concurrency: 50,\n    },\n  },\n} satisfies Config\n```\n\n\n[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/dark.png)](#commands)\n\n## Commands\n\nRun the CLI with your package manager's runner — `bunx`, `yarn dlx`, or `npx`.\n\n### Create\n\nCreates the bucket and prepares it for static hosting: sets `BucketOwnerEnforced` object ownership, makes the bucket publicly readable, and adds the static website configuration.\n\n```sh\nbunx @czfabrics/front-ready create      # Bun\nyarn dlx @czfabrics/front-ready create  # Yarn\nnpx @czfabrics/front-ready create       # npm\n```\n\n### Check\n\nVerifies that your build produces randomly named (content-hashed) chunk files, which the default cache configuration relies on. Also checks that the configured bucket exists and that it contains at least one object.\n\n```sh\nbunx @czfabrics/front-ready check      # Bun\nyarn dlx @czfabrics/front-ready check  # Yarn\nnpx @czfabrics/front-ready check       # npm\n```\n\n### Deploy\n\nBuilds your frontend using the configuration above, then uploads the output to the bucket. The file matching `indexDocumentSuffix` (default: `index.html`) is uploaded **last** — so the new entry point only becomes available once all the hashed chunks it references are already in place, avoiding a window where clients load an `index.html` pointing at chunks that haven't been uploaded yet.\n\n```sh\nbunx @czfabrics/front-ready deploy      # Bun\nyarn dlx @czfabrics/front-ready deploy  # Yarn\nnpx @czfabrics/front-ready deploy       # npm\n```\n\n\n[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/dark.png)](#license)\n\n## License\n\t\nLicensed under [MIT](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fczfabrics%2Ffront-ready","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fczfabrics%2Ffront-ready","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fczfabrics%2Ffront-ready/lists"}