Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrewjbateman/angular-app-infopwa

:clipboard: App to display information from an API. A service-worker is used to make this a Progressive Web Application (PWA).
https://github.com/andrewjbateman/angular-app-infopwa

angular angular16 css gary-simon-tutorial httpclient pwa pwa-apps rxjs service-worker typescript4

Last synced: 14 days ago
JSON representation

:clipboard: App to display information from an API. A service-worker is used to make this a Progressive Web Application (PWA).

Host: GitHub
URL: https://github.com/andrewjbateman/angular-app-infopwa
Owner: AndrewJBateman
License: mit
Created: 2018-11-10T15:57:40.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-07-09T20:25:08.000Z (over 1 year ago)
Last Synced: 2024-11-07T03:32:30.419Z (2 months ago)
Topics: angular, angular16, css, gary-simon-tutorial, httpclient, pwa, pwa-apps, rxjs, service-worker, typescript4
Language: TypeScript
Homepage:
Size: 2.02 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # :zap: Angular App Info PWA

* App to display information from an API with a fully working service worker.

* A service-worker is used to make this a Progressive Web Application (PWA).

* Partly tutorial code from [Gary Simon at DesignCourse](https://www.youtube.com/channel/UCVyRiMvfUNMA1UPlDPzG5Ow) see [:clap: Inspiration](#clap-inspiration) below, but with major modifications, including to maximise Lighthouse score.

* **Note:** to open web links in a new window use: _ctrl+click on link_

![GitHub repo size](https://img.shields.io/github/repo-size/AndrewJBateman/angular-app-infopwa?style=plastic)

![GitHub pull requests](https://img.shields.io/github/issues-pr/AndrewJBateman/angular-app-infopwa?style=plastic)

![GitHub Repo stars](https://img.shields.io/github/stars/AndrewJBateman/angular-app-infopwa?style=plastic)

![GitHub last commit](https://img.shields.io/github/last-commit/AndrewJBateman/angular-app-infopwa?style=plastic)

## :page_facing_up: Table of contents

* [:zap: Angular App Info PWA](#zap-angular-app-info-pwa)

  * [:page\_facing\_up: Table of contents](#page_facing_up-table-of-contents)

  * [:books: General info](#books-general-info)

  * [:camera: Screenshots](#camera-screenshots)

  * [:signal\_strength: Technologies](#signal_strength-technologies)

  * [:floppy\_disk: Setup](#floppy_disk-setup)

  * [:computer: Code Examples](#computer-code-examples)

  * [:cool: PWA/Angular Features](#cool-pwaangular-features)

  * [:clipboard: Status \& To-Do List](#clipboard-status--to-do-list)

  * [:clap: Inspiration](#clap-inspiration)

  * [:file\_folder: License](#file_folder-license)

  * [:envelope: Contact](#envelope-contact)

## :books: General info

* Angular httpClient used to get API data. RXJS observables are not used this time; just a simple HTTP fetch of data.

* Progressive Web App: runs in the browser and manages data caching so API info is still displayed in the event of a loss of network. All PWAs require HTTPS (hypertext transport secure). They require a TLS (SSL - Secure Sockets Layer) or Digital certificate.

## :camera: Screenshots

![Example screenshot](./img/home.png).

## :signal_strength: Technologies

* [Angular v16](https://angular.io/)

* [RxJS Library v7](https://angular.io/guide/rx-library) used to [subscribe](http://reactivex.io/documentation/operators/subscribe.html) to the API data [observable](http://reactivex.io/documentation/observable.html).

* [Angular service worker v16](https://angular.io/guide/service-worker-intro)

## :floppy_disk: Setup

* `npm i` to install dependencies

* `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

* `npm i -g http-server` to install http-server globally.

* `npm run build` to create the build file.

* `cd dist\angular-app-infoPwa` to change directory.

* `http-server -o` and navigate to `http://192.168.0.104:8080` to see API working with the service worker in operation.

* You will see something like:

  `_Starting up http-server, serving ./

  Available on:

  http://192.168.0.104:8080

  http://127.0.0.1:8080

  Hit CTRL-C to stop the server_`

## :computer: Code Examples

* `data.service.ts` using httpClient service with a `getInfo()` function to get user details from the API.

```typescript

import { Injectable } from '@angular/core';

import { HttpClient } from '@angular/common/http';

@Injectable({

  providedIn: 'root'

})

export class DataService {

  constructor(private http: HttpClient) { }

  getInfo() {

    return this.http.get("https://api.chucknorris.io/jokes/random");

  }

}

```

## :cool: PWA/Angular Features

* `Manifest.json` file

* [ngsw-config.json](https://angular.io/guide/service-worker-config) file: specifies which files and data URLs the service worker should cache and how it should update the cached files and data. Also has a URL for fonts to use when offline. Other settings, including dataGroups "freshness" strategy option.

* [SwUpdate](https://angular.io/api/service-worker/SwUpdate) module used to subscribe to update notifications from the Service Worker, trigger update checks, and forcibly activate updates.

## :clipboard: Status & To-Do List

* Status: Working

* To-Do: Reduce unused Javascript

## :clap: Inspiration

* [Coursetro tutorial: Build your First Angular PWA from Scratch (Angular 6 PWA Tutorial)](https://www.youtube.com/watch?v=othhfZ0mGjU)

* [Angular Documentation: service worker introduction](https://angular.io/guide/service-worker-intro)

* [Ensure text remains visible during webfont load](https://www.infyways.com/fix-ensure-text-remains-visible-during-webfont-load/)

## :file_folder: License

* This project is licensed under the terms of the MIT license.

## :envelope: Contact

* Repo created by [ABateman](https://github.com/AndrewJBateman), email: `[email protected]`