{"id":13424227,"url":"https://github.com/Tinkoff/angular-open-source-starter","last_synced_at":"2025-03-15T18:34:17.603Z","repository":{"id":40628103,"uuid":"208019593","full_name":"Tinkoff/angular-open-source-starter","owner":"Tinkoff","description":"This is a starter project for creating open-source libraries for Angular. It is a full fledged Angular workspace with demo application and easy library addition. It is designed to be used for open-sourcing libraries on Github and has everything you'd need ready for CI, code coverage, SSR testing, StackBlitz demo deployment and more.","archived":true,"fork":false,"pushed_at":"2023-02-21T11:10:46.000Z","size":6165,"stargazers_count":251,"open_issues_count":5,"forks_count":25,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-08-05T03:01:33.957Z","etag":null,"topics":["angular","angular-library","angular-library-quickstart","hacktoberfest","library","open-source","opensource","starter","starter-project","starter-template"],"latest_commit_sha":null,"homepage":"https://tinkoff.github.io/angular-open-source-starter/","language":"TypeScript","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/Tinkoff.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-09-12T09:59:09.000Z","updated_at":"2024-05-27T10:42:25.000Z","dependencies_parsed_at":"2024-01-28T09:52:59.006Z","dependency_job_id":null,"html_url":"https://github.com/Tinkoff/angular-open-source-starter","commit_stats":null,"previous_names":["tinkoffcreditsystems/angular-open-source-starter"],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tinkoff%2Fangular-open-source-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tinkoff%2Fangular-open-source-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tinkoff%2Fangular-open-source-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tinkoff%2Fangular-open-source-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tinkoff","download_url":"https://codeload.github.com/Tinkoff/angular-open-source-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243775789,"owners_count":20346262,"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-quickstart","hacktoberfest","library","open-source","opensource","starter","starter-project","starter-template"],"created_at":"2024-07-31T00:00:50.401Z","updated_at":"2025-03-15T18:34:12.584Z","avatar_url":"https://github.com/Tinkoff.png","language":"TypeScript","readme":"# Angular Open-source Starter\n\n[![Deploy](https://github.com/Tinkoff/angular-open-source-starter/actions/workflows/deploy.yml/badge.svg)](https://github.com/Tinkoff/angular-open-source-starter/actions/workflows/deploy.yml)\n[![Unit tests](https://github.com/Tinkoff/angular-open-source-starter/actions/workflows/test.yml/badge.svg)](https://github.com/Tinkoff/angular-open-source-starter/actions/workflows/test.yml)\n[![codecov](https://codecov.io/gh/Tinkoff/angular-open-source-starter/branch/main/graph/badge.svg?token=KfV90T6KkK)](https://codecov.io/gh/Tinkoff/angular-open-source-starter)\n[![Demo](https://img.shields.io/badge/demo-website-green)](https://tinkoff.github.io/angular-open-source-starter/)\n\n## How to use\n\n\u003e This is a starter project for creating open-source libraries for Angular. It is a full-fledged Angular workspace with\n\u003e demo application and easy library addition. It is designed to be used for open-sourcing libraries on GitHub and has\n\u003e everything you'd need ready for CI, code coverage, SSR testing, StackBlitz demo deployment and more.\n\n1. Run `npm ci` to install everything\n\n2. Use search to replace all mentions of `angular-open-source-starter` with your new library name (`npmScope` inside\n   `nx.json`, matadata of the root `package.json`, root `README.md` etc.)\n\n3. Create basic file structure via [Nx-generators](https://nx.dev/plugin-features/use-code-generators):\n\n   - `nx g @nrwl/js:library [your-library-name]` - create Typescript library. See\n     [available options](https://nx.dev/packages/js/generators/library#options).\n   - `nx g @nrwl/angular:library [your-library-name]` - create Angular library. See\n     [available options](https://nx.dev/packages/angular/generators/library#options).\n\n4. Fill in `projects/[your-library-name]/package.json` metadata for your newly generated library\n\n5. Add your email at [INSERT YOUR EMAIL HERE] in `CODE_OF_CONDUCT.md`\n\n6. Update `LICENSE` file according to your preferences\n\n7. Update root `package.json` metadata to represent your project\n\n8. Code your library and create demo for it\n\n## Cool features\n\n- [x] Versioning is ready for you with following simple commands:\n\n```json\n{\n  \"release\": \"standard-version\",\n  \"release:patch\": \"npm run release -- --release-as patch\",\n  \"release:minor\": \"npm run release -- --release-as minor\",\n  \"release:major\": \"npm run release -- --release-as major\",\n  \"publish\": \"nx run-many --target build --all --exclude=demo \u0026\u0026 nx run-many --target publish --all\"\n}\n```\n\nJust use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) format and `CHANGELOG.md` will be\nautomatically generated on releases by\n[Standard Version](https://github.com/conventional-changelog/standard-version#standard-version).\n\n- [x] This project has Angular Universal — you can easily test your library with SSR and Prerender:\n\n  `npm run serve:dev:ssr` or `npm run build:prerender \u0026\u0026 npm run serve:prerender`\n\n- [x] CI and code coverage are ready, GitHub Action checks that packages build, test and lint correctly. It also sends\n      test results to [Codecov](https://about.codecov.io).\n\n- [x] Precommit checks, prettier, linter and all that jazz is there.\n\n- [x] You can also deploy your demo to [StackBlitz](https://stackblitz.com) with no hustle, just use link in the\n      following format:\n\n         https://stackblitz.com/github/[User|Organization]/[Repository]/tree/main/projects/demo\n\n- [x] You can add more libraries using the same [Nx-generators](https://nx.dev/plugin-features/use-code-generators) to\n      create a whole Angular Workspace with multiple libraries. Versioning and publishing is configured that they are\n      released simultaneously like Angular packages.\n\n## Infrastructure\n\n- [x] GitHub Actions\n- [x] Node.js 16+, npm 8+\n- [x] Angular 12+\n- [x] TypeScript 4+\n- [x] Prettier 2.6+\n- [x] Stylelint 14+\n- [x] ESLint 7+\n- [x] Husky 7+\n- [x] Cypress 10+\n- [x] Jest 27+\n- [x] Nx 13+\n\n## Badge\n\nShow that your project is based off of our starter\n\n[![angular-open-source-starter](https://img.shields.io/badge/made%20with-angular--open--source--starter-d81676?logo=angular)](https://github.com/Tinkoff/angular-open-source-starter)\n\n```md\n[![angular-open-source-starter](https://img.shields.io/badge/made%20with-angular--open--source--starter-d81676?logo=angular)](https://github.com/Tinkoff/angular-open-source-starter)\n```\n","funding_links":[],"categories":["Кодогенерация"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTinkoff%2Fangular-open-source-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTinkoff%2Fangular-open-source-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTinkoff%2Fangular-open-source-starter/lists"}