Skip to content

Commit 0a3f727

Browse files
feature: update README for Angular 17 stack, remove obsolete @types/jasminewd2 (Protractor types)
Co-Authored-By: Eddie Mattout <eddie.mattout@cognition.ai>
1 parent f66145a commit 0a3f727

4 files changed

Lines changed: 20 additions & 20 deletions

File tree

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
<p align="center">
1616
<a href="/CONTRIBUTING.md"><img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"></a>
17-
<a href="https://travis-ci.org/housseindjirdeh/angular2-hn"><img alt="Build Status" src="https://travis-ci.org/housseindjirdeh/angular2-hn.svg?branch=master"></a>
17+
<a href="https://github.com/COG-GTM/angular2-hn/actions/workflows/ci.yml"><img alt="Build Status" src="https://github.com/COG-GTM/angular2-hn/actions/workflows/ci.yml/badge.svg"></a>
1818
</p>
1919

2020
---
@@ -71,18 +71,31 @@ More to come!
7171

7272
Feel free to send me feedback on [twitter](https://twitter.com/hdjirdeh) or [file an issue](https://github.com/hdjirdeh/angular2-hn/issues/new)! Feature requests are always welcome.
7373

74+
## Tech stack
75+
76+
This app was modernized from Angular 9 to **Angular 17**:
77+
78+
- **Angular 17** with standalone components (no `NgModule`s) and `@if`/`@for` control-flow syntax
79+
- **TypeScript 5.4**
80+
- **RxJS 7**
81+
- **esbuild** `application` builder (the default for new Angular 17 apps)
82+
- **ESLint** + [`angular-eslint`](https://github.com/angular-eslint/angular-eslint) (replacing TSLint/Codelyzer)
83+
- **Karma + Jasmine** for unit tests
84+
- **GitHub Actions** for CI (replacing Travis)
85+
- **Workbox** service worker for offline support, deployed to **Firebase Hosting**
86+
7487
## Build process
7588

76-
Note: This project has been ejected (with AOT + production settings) in order to customize Webpack configurations.
89+
The project uses the standard [Angular CLI](https://angular.io/cli) workflow:
7790

7891
- Clone or download the repo
7992
- `npm install`
80-
- `npm start` to run the application with webpack-dev-server or `npm build` to kick off a fresh build and update the output directory (`dist/`)
93+
- `npm start` to run the development server at `http://localhost:4200`
94+
- `npm run build -- --configuration production` to produce an optimized build in `dist/`
95+
- `npm test` to run unit tests
96+
- `npm run lint` to lint the project
8197

82-
Note: Any Service Worker changes will not be reflected when you run the application locally in development. To test service worker changes:
83-
- `npm build`
84-
- `npm run precache` to generate the service worker file
85-
- `npm run static-serve` to load the application along with the service worker asset using [live-server](https://github.com/tapio/live-server)
98+
The production build automatically generates the Workbox service worker, so offline behavior can be verified by serving the contents of `dist/` with any static file server.
8699

87100
## Contributors
88101

e2e/tsconfig.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"target": "es2018",
77
"types": [
88
"jasmine",
9-
"jasminewd2",
109
"node"
1110
]
1211
}

package-lock.json

Lines changed: 0 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@
3535
"@angular/compiler-cli": "^17.3.12",
3636
"@angular/language-service": "^17.3.12",
3737
"@types/jasmine": "~3.6.0",
38-
"@types/jasminewd2": "~2.0.3",
3938
"@types/node": "^20.11.0",
4039
"@typescript-eslint/eslint-plugin": "7.11.0",
4140
"@typescript-eslint/parser": "7.11.0",

0 commit comments

Comments
 (0)