-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,98 +1,34 @@ | ||
| # ZacUi | ||
| # ZAC-ui | ||
|
|
||
| This project was generated using [Nx](https://nx.dev). | ||
| ZAC-ui is de gebruikersinterface van de applicatie ZAC: Zaakafhandelcomponent. Deze applicatie stelt de gebruiker in staat om te werken met zaakgegevens en processen te beheren. | ||
|
|
||
| <p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p> | ||
| ## Documentatie | ||
|
|
||
| 🔎 **Nx is a set of Extensible Dev Tools for Monorepos.** | ||
| Dit project is gegenereerd met behulp van [Nx](https://nx.dev). | ||
|
|
||
| ## Quick Start & Documentation | ||
| 🔎 **Nx is a set of Extensible Dev Tools for Monorepos.** | ||
|
|
||
| [Nx Documentation](https://nx.dev/angular) | ||
|
|
||
| [10-minute video showing all Nx features](https://nx.dev/angular/getting-started/what-is-nx) | ||
|
|
||
| [Interactive Tutorial](https://nx.dev/angular/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 our core plugins: | ||
| ## Algemene setup | ||
|
|
||
| - [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` | ||
| Dit project bevat de applicatie [zac-ui](apps/zac-ui) in [apps/](apps), die meerdere libraries uit [libs/](libs) gebruikt. | ||
|
|
||
| There are also many [community plugins](https://nx.dev/nx-community) you could add. | ||
| ## Application | ||
|
|
||
| ## Generate an application | ||
| De enige applicatie in dit project is momenteel `apps/zac-ui`. Deze toepassingen dienen als een omhulsel voor de functies en handelen de routing af. | ||
|
|
||
| Run `ng g @nrwl/angular:app my-app` to generate an application. | ||
| ## Library | ||
|
|
||
| > You can use any of the plugins above to generate applications as well. | ||
| In de `libs/` directory vind je alle `features` en `shared` modules. Deze libraries moeten worden gegenereerd onder bepaalde voorwaarden. Gebruik het onderstaande formaat met de relevante parameters om een compatibele library te genereren. | ||
|
|
||
| When using Nx, you can create multiple applications and libraries in the same workspace. | ||
| `ng generate @nrwl/angular:library --name=$feature-name --style=scss --directory=features --importPath=@gu/$feature-name --prefix=gu --publishable --no-interactive` | ||
|
|
||
| ## 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 `@zac-ui/mylib`. | ||
| Op deze manier zijn de libraries deelbaar over andere `libs` en `apps`. Ze kunnen worden geïmporteerd vanuit `@gu/$feature-name`. | ||
|
|
||
| ## 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 `nx 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 `nx affected:e2e` to execute the end-to-end tests affected by a change. | ||
|
|
||
| ## Understand your workspace | ||
|
|
||
| Run `nx dep-graph` to see a diagram of the dependencies of your projects. | ||
|
|
||
| ## Further help | ||
|
|
||
| Visit the [Nx Documentation](https://nx.dev/angular) to learn more. | ||
|
|
||
| ## ☁ Nx Cloud | ||
|
|
||
| ### Computation Memoization in the Cloud | ||
|
|
||
| <p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-cloud-card.png"></p> | ||
|
|
||
| Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly. | ||
| Run `npm install` | ||
|
|
||
| Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers. | ||
| Dit project moet worden uitgevoerd met behulp van `docker-compose` zoals beschreven in de root [README](../../README.md). Alleen het uitvoeren van dit front-end project staat je niet toe om toegang te krijgen tot de juiste API's, aangezien de authenticatie wordt beheerd door de omhullende Django applicatie. | ||
|
|
||
| Visit [Nx Cloud](https://nx.app/) to learn more. |