Commit 4026ffda authored by Matt Teeter's avatar Matt Teeter

Fix readme

parent 845be4e2
Pipeline #73984 failed with stages
in 6 minutes and 47 seconds
# UtilsLib
# Utils Library
This project was generated using [Nx](https://nx.dev).
Monorepo for building-block type utilities that don't have dependencies on any other `@psu` libraries.
<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/nx-logo.png" width="450"></p>
- [Browser](https://git.psu.edu/ais-swe/ux/utils/tree/develop/libs/utils/browser)
- Cache Interceptor
- Autofocus Directive
- Error Service
- Loading Events Service
- Local Storage Service
- Request Tracing Interceptor
- UrlBuilder
- Window Service
- [Rx](https://git.psu.edu/ais-swe/ux/utils/tree/develop/libs/utils/rx)
- Http Retry Backoff Operator
- [Security](https://git.psu.edu/ais-swe/ux/utils/tree/develop/libs/utils/security)
- `REQUIRE_AUTH_HEADER` string constant
🔎 **Nx is a set of Angular CLI power-ups for modern development.**
# Contributing
## Quick Start & Documentation
Write small, portable utils, and try to keep the docs up to date as you add things.
[Nx Documentation](https://nx.dev)
[30-minute video showing all Nx features](https://nx.dev/getting-started/what-is-nx)
[Interactive Tutorial](https://nx.dev/tutorial/01-create-application)
## Adding capabilities to your workspace
Nx supports many plugins which add capabilities for developing different types of applications and different tools.
These capabilities include generating applications, libraries, .etc as well as the devtools to test, and build projects as well.
Below are some plugins which you can add to your workspace:
- [Angular](https://angular.io)
- `ng add @nrwl/angular`
- [React](https://reactjs.org)
- `ng add @nrwl/react`
- Web (no framework frontends)
- `ng add @nrwl/web`
- [Nest](https://nestjs.com)
- `ng add @nrwl/nest`
- [Express](https://expressjs.com)
- `ng add @nrwl/express`
- [Node](https://nodejs.org)
- `ng add @nrwl/node`
## Generate an application
Run `ng g @nrwl/angular:app my-app` to generate an application.
> You can use any of the plugins above to generate applications as well.
When using Nx, you can create multiple applications and libraries in the same workspace.
## Generate a library
Run `ng g @nrwl/angular:lib my-lib` to generate a library.
> You can also use any of the plugins above to generate libraries as well.
Libraries are sharable across libraries and applications. They can be imported from `@utils-lib/mylib`.
## Development server
Run `ng serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
## Code scaffolding
Run `ng g component my-component --project=my-app` to generate a new component.
## Build
Run `ng build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
## Running unit tests
Run `ng test my-app` to execute the unit tests via [Jest](https://jestjs.io).
Run `npm run affected:test` to execute the unit tests affected by a change.
## Running end-to-end tests
Run `ng e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io).
Run `npm run affected:e2e` to execute the end-to-end tests affected by a change.
## Understand your workspace
Run `npm run dep-graph` to see a diagram of the dependencies of your projects.
## Further help
Visit the [Nx Documentation](https://nx.dev) to learn more.
See the README here for how to create a new entry point https://git.psu.edu/ais-swe/ux/components/blob/develop/README.md
# Utils Library
Monorepo for building-block type utilities that don't have dependencies on any other `@psu` libraries.
- [Browser](https://git.psu.edu/ais-swe/ux/utils/tree/develop/libs/utils/browser)
- Cache Interceptor
- Autofocus Directive
- Error Service
- Loading Events Service
- Local Storage Service
- Request Tracing Interceptor
- UrlBuilder
- Window Service
- [Rx](https://git.psu.edu/ais-swe/ux/utils/tree/develop/libs/utils/rx)
- Http Retry Backoff Operator
- [Security](https://git.psu.edu/ais-swe/ux/utils/tree/develop/libs/utils/security)
- `REQUIRE_AUTH_HEADER` string constant
# Contributing
Write small, portable utils, and try to keep the docs up to date as you add things.
See the README here for how to create a new entry point https://git.psu.edu/ais-swe/ux/components/blob/develop/README.md
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment