{"id":15280381,"url":"https://github.com/lazycuh/angular-library-template","last_synced_at":"2025-03-23T22:41:19.538Z","repository":{"id":207889904,"uuid":"717195012","full_name":"lazycuh/angular-library-template","owner":"lazycuh","description":"A template for creating Angular libraries","archived":false,"fork":false,"pushed_at":"2024-05-27T03:10:44.000Z","size":143,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-19T16:52:23.229Z","etag":null,"topics":["angular","angular-library","angular-library-","angular-library-template"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/lazycuh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2023-11-10T19:25:53.000Z","updated_at":"2024-05-27T03:10:47.000Z","dependencies_parsed_at":"2024-07-17T07:14:18.582Z","dependency_job_id":null,"html_url":"https://github.com/lazycuh/angular-library-template","commit_stats":null,"previous_names":["babybeet/angular-library-template","lazycuh/angular-library-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazycuh%2Fangular-library-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazycuh%2Fangular-library-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazycuh%2Fangular-library-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lazycuh%2Fangular-library-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lazycuh","download_url":"https://codeload.github.com/lazycuh/angular-library-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245181527,"owners_count":20573717,"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":["angular","angular-library","angular-library-","angular-library-template"],"created_at":"2024-09-30T12:01:37.085Z","updated_at":"2025-03-23T22:41:19.516Z","avatar_url":"https://github.com/lazycuh.png","language":"Shell","readme":"# angular-library-template [![](https://circleci.com/gh/babybeet/angular-library-template.svg?style=svg\u0026logo=appveyor)](https://app.circleci.com/pipelines/github/babybeet/angular-library-template?branch=main)\n\nThis template includes the following features:\n\n- [ESLint](https://eslint.org/) for both TypeScript and HTML templates.\n- [Husky](https://typicode.github.io/husky/).\n- [lint-staged](https://www.npmjs.com/package/lint-staged) that will run ESLint, Prettier and a custom script to automatically re-generate the table of contents on every commit.\n- [Prettier](https://prettier.io/).\n- CI/CD with [CircleCI](https://circleci.com/). The pipeline has been set up to lint the source code, run all tests, build, then deploy the final package to NPM registry.\n\n## Table of contents\n\n\u003c!-- toc --\u003e\n\n- [Angular compatibility](#angular-compatibility)\n- [Installation](#installation)\n- [How to use](#how-to-use)\n  - [Configurations](#configurations)\n  - [Development](#development)\n  - [Testing](#testing)\n    - [Unit testing](#unit-testing)\n    - [Visual testing](#visual-testing)\n- [Building and publishing](#building-and-publishing)\n\n\u003c!-- tocstop --\u003e\n\n## Angular compatibility\n\n| This library | Angular |\n| ------------ | ------- |\n| 1.x.x        | 16 - 18 |\n\n\u003c!-- Remove this once ready to publish\n\n## Installation\n\n- `npm`\n\n  ```\n  npm i -S @babybeet/angular-library-template\n  ```\n\n- `pnpm`\n\n  ```\n  pnpm i -S @babybeet/angular-library-template\n  ```\n\n- `yarn`\n\n  ```\n  yarn add @babybeet/angular-library-template\n  ```\n--\u003e\n\n## How to use\n\n### Configurations\n\n- Find-and-replace all instances of `angular-library-template` with your library's name.\n- Rename folder `angular-library-template` inside `projects` to the your library name.\n- Update all component prefixes from `lc` to your own choosing.\n- Within your CircleCI's `Organization Settings`, add a new context named `npm`, and add an environment variable named `NPM_TOKEN` to that context to publish the built package to npm.\n- Add an SSH user key to your CircleCI project so that version commits can be pushed into your remote repository.\n- Create a project level environment variable named `GH_KEY` that contains the fingerprint for the SSH user key created above so that CircleCI can commit back to your repository on Github when the versioning job runs.\n\n### Development\n\nTo develop your library code, just add changes to **lib** folder.\n\nBe sure to add anything that you'd like to export to **public-api.ts** file, or else, nothing can be imported from your library.\n\n### Testing\n\n#### Unit testing\n\nExecute `pnpm test` to run all of your unit tests in watch mode, or `pnpm test:ci` to run it in non-watch mode.\n\n#### Visual testing\n\nTo visually check your components/directives, you can import them into `projects/visual-test` app and use the imported symbols as normal. Changes made to your library code will also cause the visual app to auto-reload after running `pnpm start` at the root of the product directory which will start a regular Angular app on http://localhost:4200.\n\n## Building and publishing\n\nBefore you publish your library, you should update your README file (Be sure to not change the `## Table of contents` section as this is updated automatically by a script that runs on every commit hook) and choose an appropriate software license. Anything added to **README.md** file will be copied to the final distribution inside **dist/your-library-name** folder to be published to the npm registry, additionally, the **LICENSE** file and **package.json** file inside **projects/your-library-name** folder will also be copied to distribution folder, so make sure you configure your **package.json** accordingly.\n","funding_links":[],"categories":["Table of contents"],"sub_categories":["Angular"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flazycuh%2Fangular-library-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flazycuh%2Fangular-library-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flazycuh%2Fangular-library-template/lists"}