-
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.
docs: Replace angular-starter reference
- Loading branch information
Showing
18 changed files
with
60 additions
and
181 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
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,104 +1,6 @@ | ||
|  | ||
| # WoPeD Webclient | ||
|
|
||
| > The Angular starter / boilerplate project to start a new enterprise project. | ||
| This repository contains the WoPeD Webclient. <br> | ||
| The application has been built based on [angular-starter](https://github.com/wlucha/angular-starter) | ||
|
|
||
| ✅ [Angular 16](https://angular.io/) | ||
| ✅ [Angular Material](https://material.angular.io/) | ||
| ✅ Unit Testing with [Jest](https://jestjs.io/) | ||
| ✅ End-to-End Testing with [TestCafé](https://testcafe.io/) | ||
| ✅ Internationalization with [Transloco](https://github.com/ngneat/transloco) | ||
| ✅ Auto documentation with [Compodoc](https://compodoc.app/) | ||
| ✅ Provide component examples with [Storybook](https://storybook.js.org/) | ||
| ✅ Analyse your project with [source-map-explorer](https://www.npmjs.com/package/source-map-explorer) | ||
| ✅ [Docker](https://www.docker.com/) | ||
| ✅ [ESLint](https://eslint.org/) | ||
| ✅ [Prettier](https://prettier.io/) | ||
| ✅ [Commit Linting](https://github.com/conventional-changelog/commitlint) | ||
| ✅ [AuditJS](https://www.npmjs.com/package/auditjs) Audit this application using Sonatype OSS Index | ||
| ✅ Auto-generate a CHANGELOG with [auto-changelog](https://github.com/cookpete/auto-changelog) | ||
|
|
||
| <hr> | ||
|
|
||
|  | ||
| [](https://travis-ci.org/github/wlucha/angular-starter) | ||
| []() | ||
| [](https://sonarcloud.io/dashboard?id=wlucha_angular-starter) | ||
| [](https://hub.docker.com/repository/docker/wlucha/angular-starter) | ||
| [](https://hub.docker.com/repository/docker/wlucha/angular-starter) | ||
| [](https://stackshare.io/wlucha/angular-starter) | ||
|
|
||
| ## Deploy | ||
|
|
||
| [](https://heroku.com/deploy) | ||
|
|
||
| ## Demo | ||
|
|
||
| [](https://stackblitz.com/github/wlucha/angular-starter) | ||
|
|
||
| ## Install / Development | ||
|
|
||
| ```bash | ||
| # Clone the project | ||
| $ git clone https://github.com/wlucha/angular-starter | ||
| $ cd angular-starter | ||
|
|
||
| # Install dependencies | ||
| $ npm install | ||
|
|
||
| # Start server | ||
| $ npm run start | ||
|
|
||
| # Open in browser: http://localhost:4200 | ||
| ``` | ||
|
|
||
| ## Docker Deployment | ||
|
|
||
| ```bash | ||
| # Build Docker image | ||
| $ docker build . -t angular-starter | ||
|
|
||
| # Run Docker Container | ||
| $ docker run -p 3000:80 angular-starter | ||
| ``` | ||
|
|
||
| ## Docker Hub | ||
|
|
||
| https://hub.docker.com/r/wlucha/angular-starter | ||
|
|
||
| ## Commands | ||
|
|
||
| - `npm run start` - Start the app | ||
| - `npm run lint` - Lint the project | ||
| - `npm run test` - Run unit tests | ||
| - `npm run build` - Build the project | ||
| - `npm run build:prod` - Build the project in production mode | ||
| - `npm run build:prod:stats` - Build the project in product mode with stats | ||
| - `npm run analyse` - Analyse bundle with [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) | ||
| - `npm run compodoc` - Generate [compodoc](https://github.com/compodoc/compodoc) documentation | ||
| - `npm run version` - Generate changelog | ||
| - `npm run prettier` - Format the whole project | ||
| - `npm run audit` - Audit this application using Sonatype OSS Index | ||
|
|
||
| ## License | ||
|
|
||
| MIT License | ||
|
|
||
| Copyright (c) 2023 Wilfried Lucha | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| Navigate to https://woped.github.io/woped-frontend/home to use the WoPeD Webclient. |
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
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,6 +1,6 @@ | ||
| { | ||
| "name": "Angular 14 Starter", | ||
| "description": "Angular 14 Starter project with Material, Transloco, Jest & Compodoc", | ||
| "repository": "https://github.com/wlucha/angular-starter", | ||
| "name": "WoPeD Webclient", | ||
| "description": "WoPeD Webclient", | ||
| "repository": "https://github.com/woped/woped-frontend", | ||
| "keywords": ["angular", "jest", "compodoc", "transloco"] | ||
| } |
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
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
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
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
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
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
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,36 +1,15 @@ | ||
| { | ||
| "name": "angular-starter", | ||
| "name": "woped-frontend", | ||
| "version": "0.0.1", | ||
| "description": "The Angular starter / boilerplate project to start a new enterprise project", | ||
| "author": "Wilfried Lucha <[email protected]>", | ||
| "homepage": "https://lucha.at", | ||
| "description": "The WoPeD Webclient", | ||
| "author": "The WoPeD Team <[email protected]>", | ||
| "homepage": "https://woped.org/", | ||
| "license": "MIT", | ||
| "contributors": [ | ||
| "Wilfried Lucha <[email protected]>" | ||
| ], | ||
| "keywords": [ | ||
| "angular", | ||
| "angular 15", | ||
| "angular-starter", | ||
| "angular starter", | ||
| "angular-boilerplate", | ||
| "angular boilerplate", | ||
| "angular-template", | ||
| "angular template", | ||
| "jest", | ||
| "transloco", | ||
| "prettier", | ||
| "testcafe", | ||
| "compodoc", | ||
| "docker", | ||
| "eslint", | ||
| "storybook" | ||
| ], | ||
| "repository": "https://github.com/wlucha/angular-starter.git", | ||
| "repository": "https://github.com/woped/woped-frontend.git", | ||
| "bugs": { | ||
| "url": "https://github.com/wlucha/angular-starter/issues" | ||
| "url": "https://github.com/woped/woped-frontend/issues" | ||
| }, | ||
| "readme": "https://github.com/wlucha/angular-starter/blob/master/README.md", | ||
| "readme": "https://github.com/woped/woped-frontend/blob/main/README.md", | ||
| "scripts": { | ||
| "ng": "ng", | ||
| "start": "ng serve", | ||
|
|
@@ -44,15 +23,15 @@ | |
| "lint": "ng lint", | ||
| "e2e": "testcafe chrome ./e2e/", | ||
| "compodoc": "npx compodoc -p tsconfig.app.json", | ||
| "analyze": "source-map-explorer dist/angular-starter/**/*.js", | ||
| "analyze": "source-map-explorer dist/woped-frontend/**/*.js", | ||
| "prettier": "prettier --write \"src/app/**/*.{js,json,css,scss,less,md,ts,html,component.html}\"", | ||
| "prepare": "husky install", | ||
| "audit": "auditjs ossi", | ||
| "version": "auto-changelog -p && git add CHANGELOG.md", | ||
| "docs:json": "compodoc -p ./tsconfig.json -e json -d .", | ||
| "storybook": "npm run docs:json && start-storybook -p 6006", | ||
| "build-storybook": "npm run docs:json && build-storybook", | ||
| "deploy-storybook": "npm run build-storybook && npx angular-cli-ghpages --dir=dist/angular-starter", | ||
| "deploy-storybook": "npm run build-storybook && npx angular-cli-ghpages --dir=dist/woped-frontend", | ||
| "deploy_dependency": "ng add angular-cli-ghpages", | ||
| "deploy": "ng deploy" | ||
| }, | ||
|
|
||
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
Oops, something went wrong.