|
1 | 1 | # Angular Open-source Starter
|
2 | 2 |
|
3 |
| - |
| 3 | +[](https://github.com/Tinkoff/angular-open-source-starter/actions/workflows/deploy.yml) |
| 4 | +[](https://github.com/Tinkoff/angular-open-source-starter/actions/workflows/test.yml) |
| 5 | +[](https://codecov.io/gh/Tinkoff/angular-open-source-starter) |
| 6 | +[](https://tinkoff.github.io/angular-open-source-starter/) |
4 | 7 |
|
5 | 8 | ## How to use
|
6 | 9 |
|
|
24 | 27 |
|
25 | 28 | ## Cool features
|
26 | 29 |
|
27 |
| -1. Versioning is ready for you with following simple commands: |
| 30 | +- [x] Versioning is ready for you with following simple commands: |
28 | 31 |
|
29 |
| - ```json |
30 |
| - "release": "standard-version", |
31 |
| - "release:patch": "npm run release -- --release-as patch", |
32 |
| - "release:minor": "npm run release -- --release-as minor", |
33 |
| - "release:major": "npm run release -- --release-as major", |
34 |
| - "publish": "npm run build:all && npm publish:all" |
35 |
| - ``` |
| 32 | +```json |
| 33 | +{ |
| 34 | + "release": "standard-version", |
| 35 | + "release:patch": "npm run release -- --release-as patch", |
| 36 | + "release:minor": "npm run release -- --release-as minor", |
| 37 | + "release:major": "npm run release -- --release-as major", |
| 38 | + "publish": "npm run build:all && npm publish:all" |
| 39 | +} |
| 40 | +``` |
36 | 41 |
|
37 |
| - Just use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) format and `CHANGELOG.md` |
38 |
| - will be automatically generated on releases by |
39 |
| - [Standard Version](https://github.com/conventional-changelog/standard-version#standard-version). |
| 42 | +Just use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) format and `CHANGELOG.md` will be |
| 43 | +automatically generated on releases by |
| 44 | +[Standard Version](https://github.com/conventional-changelog/standard-version#standard-version). |
40 | 45 |
|
41 |
| -2. This project has Angular Universal — you can easily test your library with SSR and Prerender: |
| 46 | +- [x] This project has Angular Universal — you can easily test your library with SSR and Prerender: |
42 | 47 |
|
43 |
| - `npm run dev:ssr` or `npm run prerender` |
| 48 | + `npm run dev:ssr` or `npm run prerender` |
44 | 49 |
|
45 |
| -3. CI and code coverage are ready, GitHub Action checks that packages build, test and lint correctly. It also sends |
46 |
| - test results to [Coveralls](https://coveralls.io). |
| 50 | +- [x] CI and code coverage are ready, GitHub Action checks that packages build, test and lint correctly. It also sends |
| 51 | + test results to [Codecov](https://about.codecov.io). |
47 | 52 |
|
48 |
| -4. Precommit checks, prettier, linter and all that jazz is there. |
| 53 | +- [x] Precommit checks, prettier, linter and all that jazz is there. |
49 | 54 |
|
50 |
| -5. You can also deploy your demo to [StackBlitz](https://stackblitz.com) with no hustle, just use link in the following |
51 |
| - format: |
| 55 | +- [x] You can also deploy your demo to [StackBlitz](https://stackblitz.com) with no hustle, just use link in the |
| 56 | + following format: |
52 | 57 |
|
53 |
| - https://stackblitz.com/github/[User|Organization]/[Repository]/tree/main/projects/demo |
| 58 | + https://stackblitz.com/github/[User|Organization]/[Repository]/tree/main/projects/demo |
54 | 59 |
|
55 |
| -6. You can add more libraries using the same `npm run add` command to create a whole Angular Workspace with multiple |
56 |
| - libraries. Versioning and publishing is configured that they are released simultaneously like Angular packages. |
| 60 | +- [x] You can add more libraries using the same `npm run add` command to create a whole Angular Workspace with multiple |
| 61 | + libraries. Versioning and publishing is configured that they are released simultaneously like Angular packages. |
57 | 62 |
|
58 |
| -## View Engine |
| 63 | +## Infrastructure |
59 | 64 |
|
60 |
| -This starter uses Angular 9. This way your libraries will be supported across all Angular versions in Ivy world. If you |
61 |
| -need to support older versions of Angular like 6 and above, you can use tag `view-engine` of this repository as your |
62 |
| -starting point as it is running Angular 7. |
| 65 | +- [x] GitHub Actions |
| 66 | +- [x] Node.js 16, npm 8 |
| 67 | +- [ ] Nx 13+ |
| 68 | +- [ ] Angular 12+ |
| 69 | +- [ ] TypeScript 4+ |
| 70 | +- [x] Prettier 2.6+ |
| 71 | +- [x] Stylelint 14+ |
| 72 | +- [x] ESLint 7+ |
| 73 | +- [x] Husky 7+ |
63 | 74 |
|
64 | 75 | ## Badge
|
65 | 76 |
|
|
0 commit comments