{"id":15295287,"url":"https://github.com/mattlewis92/generator-angular-library","last_synced_at":"2025-04-13T15:59:25.001Z","repository":{"id":44993359,"uuid":"59231143","full_name":"mattlewis92/generator-angular-library","owner":"mattlewis92","description":"A yeoman generator for scaffolding a new angular 5 module that you can publish and share straight away to npm","archived":false,"fork":false,"pushed_at":"2023-01-12T08:40:54.000Z","size":627,"stargazers_count":64,"open_issues_count":4,"forks_count":12,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-27T06:51:20.543Z","etag":null,"topics":["angular","yeoman-generator"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"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/mattlewis92.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}},"created_at":"2016-05-19T18:19:20.000Z","updated_at":"2023-11-07T07:36:31.000Z","dependencies_parsed_at":"2023-02-09T10:45:34.597Z","dependency_job_id":null,"html_url":"https://github.com/mattlewis92/generator-angular-library","commit_stats":null,"previous_names":["mattlewis92/generator-angular2-module"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattlewis92%2Fgenerator-angular-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattlewis92%2Fgenerator-angular-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattlewis92%2Fgenerator-angular-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattlewis92%2Fgenerator-angular-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattlewis92","download_url":"https://codeload.github.com/mattlewis92/generator-angular-library/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661730,"owners_count":21141450,"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","yeoman-generator"],"created_at":"2024-09-30T17:09:20.754Z","updated_at":"2025-04-13T15:59:24.969Z","avatar_url":"https://github.com/mattlewis92.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-angular-library [![Build Status](https://travis-ci.org/mattlewis92/generator-angular-library.svg?branch=master)](https://travis-ci.org/mattlewis92/generator-angular-library)\n\u003eSimply scaffold your angular 5.0+ library with this yeoman generator and start writing code without having to setup any tedious boilerplate tooling. \n\nEverything is pre-configured, from a local development server with unit tests, through to publishing your library to npm and a demo to github pages. Hopefully the [angular-cli](https://cli.angular.io/) project will one day make this generator obsolete, however currently the angular-cli is geared towards creating a full web-app rather than just a single re-usable npm library.\n\n## Installation\n\nFirst, install [Yeoman](http://yeoman.io) and `generator-angular-library` using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).\n\n```bash\nnpm install -g yo generator-angular-library\n```\n\nThen create your new repo on github, check it out and from the root of the repo folder run:\n\n```bash\nyo angular-library\n```\n\n## Folder structure\n* `src` should hold your libraries components / services / pipes etc. Organise them however you see fit!\n* `test` contains all your libraries test files. Simply suffix the filenames with `.spec.ts` and they will be auto-included and ran\n* `demo` contains a demo app that shows off your library to users. It is also handy during development as unit tests will only get you so far when developing a UI component\n\n## npm scripts\n\nOnce you've scaffolded out your library, everything is then controlled by npm scripts:\n* `npm start` to serve the demo page of your library with live-reload as you develop. Unit tests are also run in the background.\n* `npm test` will run your unit tests once and `npm run test:watch` will run them continuously\n* `npm run commit` will run the git commit wizard when you're ready to commit a change\n* `npm run release` will publish a new release. First make sure you've created the `gh-pages` branch and pushed it to github. Next change the version in package.json to the new version you would like to release, but don't commit it yet. Now run `npm run release` and the new version will be built and published to npm, as well as the demo and documentation generated and pushed to the `gh-pages` branch of your project.\n\n## Tools used\n\n* Build your library in [typescript](https://www.typescriptlang.org/) with [webpack](https://webpack.github.io/)\n* Run your tests with [karma](http://karma-runner.github.io/)\n* Auto-lint your library with [tslint](https://palantir.github.io/tslint/)\n* Automatic documentation generated with [compodoc](https://compodoc.github.io/compodoc/)\n* Publish your library to [npm](https://www.npmjs.com/)\n\n## License\n\nMIT © [Matt Lewis](https://mattlewis.me)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattlewis92%2Fgenerator-angular-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattlewis92%2Fgenerator-angular-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattlewis92%2Fgenerator-angular-library/lists"}