Skip to content

Commit

Permalink
docs: user info & gitignore updated
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewJBateman committed Jun 2, 2022
1 parent 4afcff8 commit b090ef5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ speed-measure-plugin*.json
.history/*

# misc
.env
/.angular/cache
/dist
/.sass-cache
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :zap: Angular Tailwind Unsplash

* Angular app using [Tailwindcss](https://developers.google.com/chart/) components to display images from the [Unsplash Images API](https://unsplash.com/developer)
* Angular app using [TailwindCSS](https://developers.google.com/chart/) components to display images from the [Unsplash Images API](https://unsplash.com/developer)
* **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-tailwind-unsplash?style=plastic)
Expand Down Expand Up @@ -49,7 +49,7 @@
* [Server-side rendering (SSR) with Angular Universal v13](https://angular.io/guide/universal) to render app on an express.js server
* [Angular async pipes](https://angular.io/api/common/AsyncPipe) used with Unsplash asynchronous Observable objects
* [Reactive Extensions Library for Javascript rxjs v7](https://rxjs.dev/)
* [Tailwindcss v3](https://tailwindcss.com/) CSS framework
* [TailwindCSS v3](https://tailwindcss.com/) CSS framework
* [http-server](https://www.npmjs.com/package/http-server) command-line http server to view the PWA
* [Netlify CLI](https://www.npmjs.com/package/netlify-cli) to deploy app on Netlify

Expand All @@ -62,6 +62,7 @@
* `npm run dev:ssr` to render app on local express server (SSR)
* `npm run build:ssr` to create build file with SSR, then add defer to styles file in `index.html`
* `npm run serve:ssr` to run SSR build file
* `npm run prerender` to create prerendered build file
* Run `npm run build` for a production build with css purging.
* Run `http-server` to view build on an apple/android phone or simulator (pick 2nd http address supplied)
* The build artifacts will be stored in the `dist/angular-tailwind-unsplash` directory.
Expand Down Expand Up @@ -106,7 +107,7 @@ photoQuery(): Observable<any> {
## :clipboard: Status & To-Do List

* Status: Working Server-Side-Rendered PWA. All files pass linting. Minor error with Unsplash samesite attributes to fix.
* To-Do: add eslint, splash screens, tests, deploy and replace robots file info etc. and redo lighthouse.
* To-Do: Deploy (env. variable add to Netlify), add eslint, splash screens, tests, replace robots file info etc. and redo lighthouse.

## :clap: Inspiration

Expand Down

0 comments on commit b090ef5

Please sign in to comment.