mirror of
https://git.zavage.net/Zavage-Software/skrill-frontend.git
synced 2025-01-18 11:23:42 -07:00
289 lines
14 KiB
HTML
289 lines
14 KiB
HTML
<!doctype html## Licens## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2024 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.
|
|
e
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2024 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.
|
|
>
|
|
<html class="no-js" lang="">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<title>angular-starter documentation</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
<link rel="icon" type="image/x-icon" href="./images/favicon.ico">
|
|
<link rel="stylesheet" href="./styles/style.css">
|
|
<link rel="stylesheet" href="./styles/dark.css">
|
|
</head>
|
|
<body>
|
|
<script>
|
|
// Blocking script to avaoid flickering dark mode
|
|
// Dark mode toggle button
|
|
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
|
|
var darkModeState = useDark.matches;
|
|
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
|
|
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
|
|
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
|
|
|
|
function checkToggle(check) {
|
|
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
|
|
$darkModeToggleSwitchers[i].checked = check;
|
|
}
|
|
}
|
|
|
|
function toggleDarkMode(state) {
|
|
if (window.localStorage) {
|
|
localStorage.setItem('compodoc_darkmode-state', state);
|
|
}
|
|
|
|
checkToggle(state);
|
|
|
|
const hasClass = document.body.classList.contains('dark');
|
|
|
|
if (state) {
|
|
for (var i = 0; i < $darkModeToggles.length; i++) {
|
|
$darkModeToggles[i].classList.add('dark');
|
|
}
|
|
if (!hasClass) {
|
|
document.body.classList.add('dark');
|
|
}
|
|
} else {
|
|
for (var i = 0; i < $darkModeToggles.length; i++) {
|
|
$darkModeToggles[i].classList.remove('dark');
|
|
}
|
|
if (hasClass) {
|
|
document.body.classList.remove('dark');
|
|
}
|
|
}
|
|
}
|
|
|
|
useDark.addEventListener('change', function (evt) {
|
|
toggleDarkMode(evt.matches);
|
|
});
|
|
if (darkModeStateLocal) {
|
|
darkModeState = darkModeStateLocal === 'true';
|
|
}
|
|
toggleDarkMode(darkModeState);
|
|
</script>
|
|
|
|
<div class="navbar navbar-default navbar-fixed-top d-block d-sm-none">
|
|
<a href="./" class="navbar-brand">angular-starter documentation</a>
|
|
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
|
|
</div>
|
|
|
|
<div class="xs-menu menu" id="mobile-menu">
|
|
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
|
|
</div>
|
|
|
|
<div class="container-fluid main">
|
|
<div class="row main">
|
|
<div class="hidden-xs menu">
|
|
<compodoc-menu mode="normal"></compodoc-menu>
|
|
</div>
|
|
<!-- START CONTENT -->
|
|
<div class="content getting-started">
|
|
<div class="content-data">
|
|
|
|
<p><img src="https://user-images.githubusercontent.com/7531596/128626297-df86020b-1cdc-43b5-a692-6c4c45534ec1.png" alt="81993396-d5142b00-9645-11ea-995f-98342b7d5c8f" class="img-responsive"></p>
|
|
<blockquote>
|
|
<p>The Angular starter / boilerplate project to start a new enterprise project.</p>
|
|
</blockquote>
|
|
<p>✅ <a href="https://angular.io/">Angular 17</a><br>✅ <a href="https://material.angular.io/">Angular Material</a><br>✅ Unit Testing with <a href="https://jestjs.io/">Jest</a><br>✅ End-to-End Testing with <a href="https://www.cypress.io/">Cypress</a><br>✅ Internationalization with <a href="https://github.com/ngneat/transloco">Transloco</a><br>✅ Auto documentation with <a href="https://compodoc.app/">Compodoc</a><br>✅ Provide component examples with <a href="https://storybook.js.org/">Storybook</a><br>✅ Analyse your project with <a href="https://www.npmjs.com/package/source-map-explorer">source-map-explorer</a><br>✅ <a href="https://www.docker.com/">Docker</a><br>✅ <a href="https://eslint.org/">ESLint</a><br>✅ <a href="https://prettier.io/">Prettier</a><br>✅ <a href="https://github.com/conventional-changelog/commitlint">Commit Linting</a><br>✅ <a href="https://www.npmjs.com/package/auditjs">AuditJS</a> Audit this application using Sonatype OSS Index<br>✅ Auto-generate a CHANGELOG with <a href="https://github.com/cookpete/auto-changelog">auto-changelog</a></p>
|
|
<hr>
|
|
|
|
<p><img src="https://img.shields.io/badge/Angular-17-brightgreen" alt="Angular17" class="img-responsive">
|
|
<a href=""><img src="https://img.shields.io/packagist/l/doctrine/orm.svg" alt="MIT" class="img-responsive"></a>
|
|
<a href="https://sonarcloud.io/dashboard?id=wlucha_angular-starter"><img src="https://sonarcloud.io/api/project_badges/measure?project=wlucha_angular-starter&metric=alert_status" alt="Quality Gate Status" class="img-responsive"></a>
|
|
<a href="https://hub.docker.com/repository/docker/wlucha/angular-starter"><img src="https://img.shields.io/docker/pulls/wlucha/angular-starter" alt="Docker Pulls" class="img-responsive"></a>
|
|
<a href="https://hub.docker.com/repository/docker/wlucha/angular-starter"><img src="https://img.shields.io/docker/image-size/wlucha/angular-starter" alt="Docker Image Size (latest by date)" class="img-responsive"></a>
|
|
<a href="https://stackshare.io/wlucha/angular-starter"><img src="http://img.shields.io/badge/tech-stack-0690fa.svg?style=flat" alt="StackShare" class="img-responsive"></a></p>
|
|
<h2>Deploy</h2>
|
|
<p><a href="https://heroku.com/deploy"><img src="https://www.herokucdn.com/deploy/button.png" alt="Deploy" class="img-responsive"></a></p>
|
|
<h2>Demo</h2>
|
|
<p><a href="https://stackblitz.com/github/wlucha/angular-starter"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="StackBlitz Demo" class="img-responsive"></a></p>
|
|
<h2>Install / Development</h2>
|
|
<b>Example :</b><div><pre class="line-numbers"><code class="language-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</code></pre></div><h2>Docker Deployment</h2>
|
|
<b>Example :</b><div><pre class="line-numbers"><code class="language-bash"># Build Docker image
|
|
$ docker build . -t angular-starter
|
|
|
|
# Run Docker Container
|
|
$ docker run -p 3000:80 angular-starter</code></pre></div><h2>Docker Hub</h2>
|
|
<p><a href="https://hub.docker.com/r/wlucha/angular-starter">https://hub.docker.com/r/wlucha/angular-starter</a></p>
|
|
<h2>Commands</h2>
|
|
<ul>
|
|
<li><code>npm run start</code> - Start the app</li>
|
|
<li><code>npm run lint</code> - Lint the project</li>
|
|
<li><code>npm run test</code> - Run unit tests</li>
|
|
<li><code>npm run build</code> - Build the project</li>
|
|
<li><code>npm run build:prod</code> - Build the project in production mode</li>
|
|
<li><code>npm run build:prod:stats</code> - Build the project in product mode with stats</li>
|
|
<li><code>npm run analyse</code> - Analyse bundle with <a href="https://github.com/webpack-contrib/webpack-bundle-analyzer">webpack-bundle-analyzer</a></li>
|
|
<li><code>npm run compodoc</code> - Generate <a href="https://github.com/compodoc/compodoc">compodoc</a> documentation</li>
|
|
<li><code>npm run version</code> - Generate changelog</li>
|
|
<li><code>npm run prettier</code> - Format the whole project</li>
|
|
<li><code>npm run audit</code> - Audit this application using Sonatype OSS Index</li>
|
|
</ul>
|
|
<h2>License</h2>
|
|
<p>MIT License</p>
|
|
<p>Copyright (c) 2024 Wilfried Lucha</p>
|
|
<p>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:</p>
|
|
<p>The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.</p>
|
|
<p>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.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div><div class="search-results">
|
|
<div class="has-results">
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
</div>
|
|
<div class="no-results">
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<!-- END CONTENT -->
|
|
</div>
|
|
</div>
|
|
|
|
<label class="dark-mode-switch">
|
|
<input type="checkbox">
|
|
<span class="slider">
|
|
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
|
|
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
|
|
</svg>
|
|
</span>
|
|
</label>
|
|
|
|
<script>
|
|
var COMPODOC_CURRENT_PAGE_DEPTH = 0;
|
|
var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
|
|
var COMPODOC_CURRENT_PAGE_URL = 'index.html';
|
|
var MAX_SEARCH_RESULTS = 15;
|
|
</script>
|
|
|
|
<script>
|
|
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
|
|
checkToggle(darkModeState);
|
|
if ($darkModeToggleSwitchers.length > 0) {
|
|
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
|
|
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
|
|
darkModeState = !darkModeState;
|
|
toggleDarkMode(darkModeState);
|
|
});
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<script src="./js/libs/custom-elements.min.js"></script>
|
|
<script src="./js/libs/lit-html.js"></script>
|
|
|
|
<script src="./js/menu-wc.js" defer></script>
|
|
<script nomodule src="./js/menu-wc_es5.js" defer></script>
|
|
|
|
<script src="./js/libs/bootstrap-native.js"></script>
|
|
|
|
<script src="./js/libs/es6-shim.min.js"></script>
|
|
<script src="./js/libs/EventDispatcher.js"></script>
|
|
<script src="./js/libs/promise.min.js"></script>
|
|
<script src="./js/libs/zepto.min.js"></script>
|
|
|
|
<script src="./js/compodoc.js"></script>
|
|
|
|
<script src="./js/tabs.js"></script>
|
|
<script src="./js/menu.js"></script>
|
|
<script src="./js/libs/clipboard.min.js"></script>
|
|
<script src="./js/libs/prism.js"></script>
|
|
<script src="./js/sourceCode.js"></script>
|
|
<script src="./js/search/search.js"></script>
|
|
<script src="./js/search/lunr.min.js"></script>
|
|
<script src="./js/search/search-lunr.js"></script>
|
|
<script src="./js/search/search_index.js"></script>
|
|
<script src="./js/lazy-load-graphs.js"></script>
|
|
|
|
|
|
</body>
|
|
</html>
|