diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml deleted file mode 100644 index 0f02f7c7..00000000 --- a/.github/workflows/codeql-analysis.yml +++ /dev/null @@ -1,62 +0,0 @@ -# For most projects, this workflow file will not need changing; you simply need -# to commit it to your repository. -# -# You may wish to alter this file to override the set of languages analyzed, -# or to provide custom queries or build logic. -name: "CodeQL" - -on: - push: - branches: [master] - pull_request: - # The branches below must be a subset of the branches above - branches: [master] - schedule: - - cron: '0 11 * * 5' - -jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - - strategy: - fail-fast: false - matrix: - # Override automatic language detection by changing the below list - # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python'] - language: ['javascript'] - # Learn more... - # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection - - steps: - - name: Checkout repository - uses: actions/checkout@v2 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - # queries: ./path/to/local/query, your-org/your-repo/queries@main - - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@v1 - - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 https://git.io/JvXDl - - # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines - # and modify them (or add more) to build your code if your project - # uses a compiled language - - #- run: | - # make bootstrap - # make release - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index cb189423..00b15c46 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,17 +1,16 @@ name: github pages - on: + workflow_dispatch: push: branches: - main pull_request: - jobs: deploy: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 with: node-version: '14' - name: Install dependencies diff --git a/.github/workflows/node.js-ci.yml b/.github/workflows/node.js-ci.yml deleted file mode 100644 index 72ec0810..00000000 --- a/.github/workflows/node.js-ci.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: Hyas CI - -on: - push: - branches: master - pull_request: - branches: master - -jobs: - build: - runs-on: ${{ matrix.os }} - - strategy: - matrix: - os: [ubuntu-latest, windows-latest, macos-latest] - node: [14.x, 16.x] - - steps: - - name: Check out Hyas project - uses: actions/checkout@v2 - - - name: Set up Node.js ${{ matrix.node }} - uses: actions/setup-node@v2 - with: - node-version: ${{ matrix.node }} - - - name: Install dependencies - run: npm ci - - - name: Run Hyas test script - run: npm test - - - name: Build production website - run: npm run build \ No newline at end of file diff --git a/.gitignore b/.gitignore index a4f7c608..c39af7e5 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,6 @@ public resources # Local Netlify folder .netlify -TODO \ No newline at end of file +.idea +TODO +.vs diff --git a/data/.gitkeep b/.hugo_build.lock similarity index 100% rename from data/.gitkeep rename to .hugo_build.lock diff --git a/.stylelintrc.json b/.stylelintrc.json index 1490802c..191d0938 100644 --- a/.stylelintrc.json +++ b/.stylelintrc.json @@ -1,8 +1,22 @@ { - "extends": "stylelint-config-standard", + "extends": "stylelint-config-standard-scss", "rules": { "no-empty-source": null, "string-quotes": "double", + "scss/comment-no-empty": null, + "max-line-length": null, + "scss/at-extend-no-missing-placeholder": null, + "scss/dollar-variable-colon-space-after": null, + "scss/dollar-variable-empty-line-before": null, + "color-function-notation": null, + "alpha-value-notation": null, + "selector-id-pattern": null, + "selector-class-pattern": null, + "scss/no-global-function-names": null, + "number-max-precision": null, + "hue-degree-notation": null, + "value-no-vendor-prefix": null, + "property-no-vendor-prefix": null, "at-rule-no-unknown": [ true, { diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d918e77..084c3b31 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,8 +4,35 @@ All notable changes to this project will be documented in this file. Dates are d Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). +#### [v0.3.5](https://github.com/h-enk/doks/compare/v0.3.4...v0.3.5) + +- feat: add versioning setup [`#478`](https://github.com/h-enk/doks/pull/478) +- feat: adjust latex svg image to dark theme [`#460`](https://github.com/h-enk/doks/pull/460) +- fix: edit-page multi-language support [`#459`](https://github.com/h-enk/doks/pull/459) +- feat: add docsRepoBranch config [`#458`](https://github.com/h-enk/doks/pull/458) +- feat: image max width [`#457`](https://github.com/h-enk/doks/pull/457) +- fix: docs url [`#456`](https://github.com/h-enk/doks/pull/456) +- chore(deps-dev): bump @babel/cli from 7.15.4 to 7.15.7 [`#463`](https://github.com/h-enk/doks/pull/463) +- feat: add multilingual support [`#454`](https://github.com/h-enk/doks/pull/454) +- deps: bump versions to latest [`94bacd3`](https://github.com/h-enk/doks/commit/94bacd3492e7b4d1e46aef13f86e5924ac645f4e) +- deps: bump @babel/cli from 7.15.4 to 7.15.7 [`130a13b`](https://github.com/h-enk/doks/commit/130a13bd9d3891d995e7373cc9a64fa527b4ce26) +- deps: bump versions to latest [`2503f5a`](https://github.com/h-enk/doks/commit/2503f5adf6d2650b82928a8770c2a1ccdc368a0c) + +#### [v0.3.4](https://github.com/h-enk/doks/compare/v0.3.3...v0.3.4) + +> 7 September 2021 + +- chore: update edit page default branch from master to main [`#426`](https://github.com/h-enk/doks/pull/426) +- Update index.js [`#417`](https://github.com/h-enk/doks/pull/417) +- Make id unique collapsible sidebar [`#378`](https://github.com/h-enk/doks/pull/378) +- deps: bump versions to latest [`8a98716`](https://github.com/h-enk/doks/commit/8a9871654e03b79082cfd9ebdf49a0a8ce7e21eb) +- deps: bump version to latest [`23d9dd7`](https://github.com/h-enk/doks/commit/23d9dd75c381b0440f4db717d63bea61baa0c584) +- deps: bump versions to latest [`700e566`](https://github.com/h-enk/doks/commit/700e56611d3a83f33e786f51a191728db7267248) + #### [v0.3.3](https://github.com/h-enk/doks/compare/v0.3.2...v0.3.3) +> 5 July 2021 + - Add Mermaid support [`#369`](https://github.com/h-enk/doks/pull/369) - Fix lint tests on Linux. [`#373`](https://github.com/h-enk/doks/pull/373) - feat: add mermaid [`f1fa5c5`](https://github.com/h-enk/doks/commit/f1fa5c5936558ff0b62d8a150bf303629bf50840) diff --git a/README.md b/README.md index 8b137891..0de42a4f 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ +# FullStackHero's Documentation +## How to contribute? + +1. Fork this Repository. +2. Navigate to your newly forked Repository -> Settings -> Secrets. +3. Here, Add a new Repository Secret with a name `GT_TOKEN`. As for the value, paste in your GitHub Token (https://github.com/settings/tokens) +4. Now, clone this repository locally. +5. Ensure that you have Node.js and Visual Code installed. +6. At the root of the repository run `npm install`. This installs all the required packages. +7. All the documentations are to be written in markdown format. +8. Refer https://github.com/fullstackhero/docs/blob/main/content/en/dotnet-webapi-boilerplate/general/getting-started/index.md to get an idea on how to write documentation and include images, code snippets and stuff. +9. To run the application locally, run the command `npm run start` and navigate to localhost:1313 +10. Once ready, send a Pull Request. diff --git a/archetypes/blog.md b/archetypes/blog.md index 78733514..b4ad21a4 100644 --- a/archetypes/blog.md +++ b/archetypes/blog.md @@ -9,5 +9,3 @@ weight: 50 images: ["{{ .Name | urlize }}.jpg"] contributors: [] --- - -{{< img src="{{ .Name | urlize }}.jpg" alt="{{ replace .Name "-" " " | title }}" caption="{{ replace .Name "-" " " | title }}" class="wide" >}} diff --git a/archetypes/docs.md b/archetypes/docs.md index bb609d26..436bd086 100644 --- a/archetypes/docs.md +++ b/archetypes/docs.md @@ -6,11 +6,9 @@ date: {{ .Date }} lastmod: {{ .Date }} draft: true images: [] -menu: +menu: docs: parent: "" weight: 999 toc: true --- - -{{< img src="{{ .Name | urlize }}.jpg" alt="{{ replace .Name "-" " " | title }}" caption="{{ replace .Name "-" " " | title }}" >}} diff --git a/archetypes/docs/_index.md b/archetypes/docs/_index.md new file mode 100644 index 00000000..3ed05403 --- /dev/null +++ b/archetypes/docs/_index.md @@ -0,0 +1,10 @@ +--- +title: "Docs" +description: "" +lead: "" +date: 2022-01-25T14:40:56+01:00 +lastmod: 2022-01-25T14:40:56+01:00 +draft: false +images: [] +type: docs +--- diff --git a/archetypes/docs/lorem/_index.md b/archetypes/docs/lorem/_index.md new file mode 100644 index 00000000..c1b50ae6 --- /dev/null +++ b/archetypes/docs/lorem/_index.md @@ -0,0 +1,10 @@ +--- +title: "Lorem" +description: "" +lead: "" +date: 2022-01-25T14:41:21+01:00 +lastmod: 2022-01-25T14:41:21+01:00 +draft: false +images: [] +type: docs +--- diff --git a/archetypes/docs/lorem/ipsum/index.md b/archetypes/docs/lorem/ipsum/index.md new file mode 100644 index 00000000..2cc63950 --- /dev/null +++ b/archetypes/docs/lorem/ipsum/index.md @@ -0,0 +1,15 @@ +--- +title: "Ipsum" +description: "" +lead: "" +date: 2022-01-25T14:41:39+01:00 +lastmod: 2022-01-25T14:41:39+01:00 +draft: false +images: [] +type: docs +menu: + {{ .Section }}: + parent: "lorem" +weight: 100 +toc: true +--- diff --git a/assets/js/alert-init.js b/assets/js/alert-init.js new file mode 100644 index 00000000..af3ac325 --- /dev/null +++ b/assets/js/alert-init.js @@ -0,0 +1,5 @@ +Object.keys(localStorage).forEach(function(key) { + if (/^global-alert-/.test(key)) { + document.documentElement.setAttribute('data-global-alert', 'closed'); + } +}); \ No newline at end of file diff --git a/assets/js/alert.js b/assets/js/alert.js new file mode 100644 index 00000000..1956103d --- /dev/null +++ b/assets/js/alert.js @@ -0,0 +1,20 @@ +var announcement = document.getElementById('announcement'); + +if (announcement !== null) { + + var id = announcement.dataset.id; + + Object.keys(localStorage).forEach(function(key) { + if (/^global-alert-/.test(key)) { + if (key !== id ) { + localStorage.removeItem(key); + document.documentElement.removeAttribute('data-global-alert'); + } + } + }); + + announcement.addEventListener('closed.bs.alert', () => { + localStorage.setItem(id, 'closed'); + }); + +} \ No newline at end of file diff --git a/assets/js/darkmode-init.js b/assets/js/darkmode-init.js new file mode 100644 index 00000000..0f3508de --- /dev/null +++ b/assets/js/darkmode-init.js @@ -0,0 +1,21 @@ +const globalDark = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches; +const localMode = localStorage.getItem('theme'); + +if (globalDark && (localMode === null)) { + + localStorage.setItem('theme', 'dark'); + document.documentElement.setAttribute('data-dark-mode', ''); + +} + +if (globalDark && (localMode === 'dark')) { + + document.documentElement.setAttribute('data-dark-mode', ''); + +} + +if (localMode === 'dark') { + + document.documentElement.setAttribute('data-dark-mode', ''); + +} diff --git a/assets/js/darkmode.js b/assets/js/darkmode.js index 4d8bcce6..e81db47d 100644 --- a/assets/js/darkmode.js +++ b/assets/js/darkmode.js @@ -1,12 +1,38 @@ -document.getElementById('mode').addEventListener('click', () => { +const mode = document.getElementById('mode'); - document.body.classList.toggle('dark'); - localStorage.setItem('theme', document.body.classList.contains('dark') ? 'dark' : 'light'); +if (mode !== null) { -}); + window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => { -if (localStorage.getItem('theme') === 'dark') { + if (event.matches) { - document.body.classList.add('dark'); + localStorage.setItem('theme', 'dark'); + document.documentElement.setAttribute('data-dark-mode', ''); + + } else { + + localStorage.setItem('theme', 'light'); + document.documentElement.removeAttribute('data-dark-mode'); + + } + + }) + + mode.addEventListener('click', () => { + + document.documentElement.toggleAttribute('data-dark-mode'); + localStorage.setItem('theme', document.documentElement.hasAttribute('data-dark-mode') ? 'dark' : 'light'); + + }); + + if (localStorage.getItem('theme') === 'dark') { + + document.documentElement.setAttribute('data-dark-mode', ''); + + } else { + + document.documentElement.removeAttribute('data-dark-mode'); + + } } diff --git a/assets/js/index.js b/assets/js/index.js index 05a0c6ac..17dd8835 100644 --- a/assets/js/index.js +++ b/assets/js/index.js @@ -1,20 +1,19 @@ var suggestions = document.getElementById('suggestions'); -var userinput = document.getElementById('userinput'); +var search = document.getElementById('search'); -document.addEventListener('keydown', inputFocus); +if (search !== null) { + document.addEventListener('keydown', inputFocus); +} function inputFocus(e) { - - if (e.keyCode === 191 ) { + if (e.ctrlKey && e.key === '/' ) { e.preventDefault(); - userinput.focus(); + search.focus(); } - - if (e.keyCode === 27 ) { - userinput.blur(); + if (e.key === 'Escape' ) { + search.blur(); suggestions.classList.add('d-none'); } - } document.addEventListener('click', function(event) { @@ -34,28 +33,28 @@ Source: document.addEventListener('keydown',suggestionFocus); -function suggestionFocus(e){ +function suggestionFocus(e) { + const suggestionsHidden = suggestions.classList.contains('d-none'); + if (suggestionsHidden) return; - const focusableSuggestions= suggestions.querySelectorAll('a'); - const focusable= [...focusableSuggestions]; - const index = focusable.indexOf(document.activeElement); + const focusableSuggestions= [...suggestions.querySelectorAll('a')]; + if (focusableSuggestions.length === 0) return; - let nextIndex = 0; + const index = focusableSuggestions.indexOf(document.activeElement); - if (e.keyCode === 38) { + if (e.key === "ArrowUp") { e.preventDefault(); - nextIndex= index > 0 ? index-1 : 0; + const nextIndex = index > 0 ? index - 1 : 0; focusableSuggestions[nextIndex].focus(); } - else if (e.keyCode === 40) { + else if (e.key === "ArrowDown") { e.preventDefault(); - nextIndex= index+1 < focusable.length ? index+1 : index; + const nextIndex= index + 1 < focusableSuggestions.length ? index + 1 : index; focusableSuggestions[nextIndex].focus(); } } - /* Source: - https://github.com/nextapps-de/flexsearch#index-documents-field-search @@ -102,10 +101,14 @@ Source: {{ range $index, $element := $list -}} { id: {{ $index }}, - href: "{{ .Permalink }}", + href: "{{ .RelPermalink }}", title: {{ .Title | jsonify }}, - description: {{ .Params.description | jsonify }}, - content: {{ .Content | jsonify }} + {{ with .Description -}} + description: {{ . | jsonify }}, + {{ else -}} + description: {{ .Summary | plainify | jsonify }}, + {{ end -}} + content: {{ .Plain | jsonify }} }) {{ if ne (add $index 1) $len -}} .add( @@ -113,51 +116,54 @@ Source: {{ end -}} ; - - userinput.addEventListener('input', show_results, true); - suggestions.addEventListener('click', accept_suggestion, true); + search.addEventListener('input', show_results, true); function show_results(){ const maxResult = 5; + var searchQuery = this.value; + var results = index.search(searchQuery, {limit: maxResult, enrich: true}); + + // flatten results since index.search() returns results for each indexed field + const flatResults = new Map(); // keyed by href to dedupe results + for (const result of results.flatMap(r => r.result)) { + if (flatResults.has(result.doc.href)) continue; + flatResults.set(result.doc.href, result.doc); + } - var value = this.value; - var results = index.search(value, {limit: maxResult, enrich: true}); - - suggestions.classList.remove('d-none'); suggestions.innerHTML = ""; + suggestions.classList.remove('d-none'); - //flatSearch now returns results for each index field. create a single list - const flatResults = {}; //keyed by href to dedupe results - results.forEach(result=>{ - result.result.forEach(r=>{ - flatResults[r.doc.href] = r.doc; - }); - }); - - //construct a list of suggestions list - for(const href in flatResults) { - const doc = flatResults[href]; + // inform user that no results were found + if (flatResults.size === 0 && searchQuery) { + const noResultsMessage = document.createElement('div') + noResultsMessage.innerHTML = `No results for "${searchQuery}"` + noResultsMessage.classList.add("suggestion__no-results"); + suggestions.appendChild(noResultsMessage); + return; + } + // construct a list of suggestions + for(const [href, doc] of flatResults) { const entry = document.createElement('div'); - entry.innerHTML = ''; - - entry.querySelector('a').href = href; - entry.querySelector('span:first-child').textContent = doc.title; - entry.querySelector('span:nth-child(2)').textContent = doc.description; - suggestions.appendChild(entry); - if(suggestions.childElementCount == maxResult) break; - } - } - function accept_suggestion(){ + const a = document.createElement('a'); + a.href = href; + entry.appendChild(a); - while(suggestions.lastChild){ + const title = document.createElement('span'); + title.textContent = doc.title; + title.classList.add("suggestion__title"); + a.appendChild(title); - suggestions.removeChild(suggestions.lastChild); - } + const description = document.createElement('span'); + description.textContent = doc.description; + description.classList.add("suggestion__description"); + a.appendChild(description); - return false; - } + suggestions.appendChild(entry); + if(suggestions.childElementCount == maxResult) break; + } + } }()); diff --git a/assets/js/mermaid.js b/assets/js/mermaid.js index 2ab0b9a7..b214d5f7 100644 --- a/assets/js/mermaid.js +++ b/assets/js/mermaid.js @@ -1,4 +1,4 @@ -import mermaid from 'mermaid/dist/mermaid'; +import mermaid from 'mermaid'; var config = { theme: 'default', diff --git a/assets/scss/common/_dark.scss b/assets/scss/common/_dark.scss index 9f83efb5..34cb4001 100644 --- a/assets/scss/common/_dark.scss +++ b/assets/scss/common/_dark.scss @@ -4,12 +4,16 @@ $body-bg-dark: $gray-900; $body-overlay-dark: darken($body-bg-dark, 2.5%); + +/* $border-dark: darken($body-bg-dark, 2.5%); +*/ +$border-dark: $gray-800; $body-color-dark: $gray-300; $dots-dark: darken($body-color-dark, 50%); $link-color-dark: $primary; -$button-color-dark: $primary; +$button-color-dark: $link-color-dark; $focus-color-dark: lighten($link-color-dark, 2.5%); $navbar-dark-color: $body-color-dark; @@ -18,117 +22,169 @@ $navbar-dark-active-color: $link-color-dark; /** Theme styles */ -body.dark { +[data-dark-mode] body { background: $body-bg-dark; color: $body-color-dark; } -body.dark a { +[data-dark-mode] body a { color: $link-color-dark; } -body.dark a.text-body { +[data-dark-mode] body a.text-body { color: $body-color-dark !important; } -body.dark .btn-primary { +[data-dark-mode] body .btn-primary { @include button-variant($button-color-dark, $button-color-dark); + color: $white !important; } -body.dark .btn-outline-primary { +[data-dark-mode] body .btn-outline-primary { @include button-outline-variant($button-color-dark, $button-color-dark); color: $link-color-dark; } -body.dark .btn-outline-primary:hover { +[data-dark-mode] body .btn-outline-primary:hover { color: $body-bg-dark; } -body.dark .navbar { - background: $body-bg-dark; - opacity: 0.975; +[data-dark-mode] body .btn-doks-light { + color: $navbar-dark-color; +} + +[data-dark-mode] body .show > .btn-doks-light, +[data-dark-mode] body .btn-doks-light:hover, +[data-dark-mode] body .btn-doks-light:active { + color: $link-color-dark; +} + +[data-dark-mode] body .btn-menu svg { + color: $body-color-dark; +} + +[data-dark-mode] body .doks-sidebar-toggle { + color: $navbar-dark-color; +} + +[data-dark-mode] body .btn-menu:hover, +[data-dark-mode] body .btn-doks-light:hover, +[data-dark-mode] body .doks-sidebar-toggle:hover { + background: $body-overlay-dark; +} + +/* +[data-dark-mode] body .dropdown-menu { + @extend .dropdown-menu-dark; +} +*/ + +[data-dark-mode] body .navbar, +[data-dark-mode] body .doks-subnavbar { + background-color: rgba(33, 37, 41, 0.95); border-bottom: 1px solid $border-dark; } -body.dark.home .navbar { +[data-dark-mode] body.home .navbar { border-bottom: 0; } -body.dark .navbar-light .navbar-brand { +[data-dark-mode] body .offcanvas-header { + border-bottom: 1px solid $gray-800; +} + +[data-dark-mode] body .offcanvas .nav-link { + color: $body-color-dark; +} + +[data-dark-mode] body .offcanvas .nav-link:hover, +[data-dark-mode] body .offcanvas .nav-link:focus { + color: $link-color-dark; +} + +[data-dark-mode] body .offcanvas .nav-link.active { + color: $white; +} + +[data-dark-mode] body .navbar-light .navbar-brand { color: $navbar-dark-color !important; } -body.dark .navbar-light .navbar-nav .nav-link { +[data-dark-mode] body .navbar-light .navbar-nav .nav-link { color: $navbar-dark-color; } -body.dark .navbar-light .navbar-nav .nav-link:hover, -body.dark .navbar-light .navbar-nav .nav-link:focus { +[data-dark-mode] body .navbar-light .navbar-nav .nav-link:hover, +[data-dark-mode] body .navbar-light .navbar-nav .nav-link:focus { color: $navbar-dark-hover-color; } -body.dark .navbar-light .navbar-nav .nav-link.disabled { +[data-dark-mode] body .navbar-light .navbar-nav .nav-link.disabled { color: $navbar-dark-disabled-color; } -body.dark .navbar-light .navbar-nav .show > .nav-link, -body.dark .navbar-light .navbar-nav .active > .nav-link, -body.dark .navbar-light .navbar-nav .nav-link.show, -body.dark .navbar-light .navbar-nav .nav-link.active { +[data-dark-mode] body .navbar-light .navbar-nav .show > .nav-link, +[data-dark-mode] body .navbar-light .navbar-nav .active > .nav-link, +[data-dark-mode] body .navbar-light .navbar-nav .nav-link.show, +[data-dark-mode] body .navbar-light .navbar-nav .nav-link.active { color: $navbar-dark-active-color; } -body.dark .navbar-light .navbar-text { +[data-dark-mode] body .navbar-light .navbar-text { color: $navbar-dark-color; } -body.dark .alert-primary a { - color: $body-bg-dark; +[data-dark-mode] body .alert-primary a { + color: $white; } -body.dark .alert-warning { +[data-dark-mode] body .alert-doks { background: $body-overlay-dark; color: $body-color-dark; } -body.dark .page-links a { +[data-dark-mode] body .alert-doks a { + color: $link-color-dark; +} + +[data-dark-mode] body .page-links a { color: $body-color-dark; } -body.dark .btn-toggle-nav a { +[data-dark-mode] body .btn-toggle-nav a { color: $body-color-dark; } -body.dark .showcase-meta a { +[data-dark-mode] body .showcase-meta a { color: $body-color-dark; } -body.dark .showcase-meta a:hover, -body.dark .showcase-meta a:focus { +[data-dark-mode] body .showcase-meta a:hover, +[data-dark-mode] body .showcase-meta a:focus { color: $link-color-dark; } -body.dark .docs-link:hover, -body.dark .docs-link.active, -body.dark .page-links a:hover { +[data-dark-mode] body .docs-link:hover, +[data-dark-mode] body .docs-link.active, +[data-dark-mode] body .page-links a:hover { text-decoration: none; color: $link-color-dark; } -body.dark .btn-toggle { +[data-dark-mode] body .btn-toggle { color: $body-color-dark; background-color: transparent; border: 0; } -body.dark .btn-toggle:hover, -body.dark .btn-toggle:focus { +[data-dark-mode] body .btn-toggle:hover, +[data-dark-mode] body .btn-toggle:focus { color: $body-color-dark; } -body.dark .btn-toggle::before { +[data-dark-mode] body .btn-toggle::before { width: 1.25em; line-height: 0; content: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='14' height='14' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='rgba%28222, 226, 230, 0.75%29' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M5 14l6-6-6-6'/%3e%3c/svg%3e"); @@ -137,59 +193,65 @@ body.dark .btn-toggle::before { margin-bottom: 0.125rem; } -body.dark .btn-toggle[aria-expanded="true"] { +[data-dark-mode] body .btn-toggle[aria-expanded="true"] { color: $body-color-dark; } -body.dark .btn-toggle[aria-expanded="true"]::before { +[data-dark-mode] body .btn-toggle[aria-expanded="true"]::before { transform: rotate(90deg); } -body.dark .btn-toggle-nav a:hover, -body.dark .btn-toggle-nav a:focus { +[data-dark-mode] body .btn-toggle-nav a:hover, +[data-dark-mode] body .btn-toggle-nav a:focus { color: $link-color-dark; } -body.dark .btn-toggle-nav a.active { +[data-dark-mode] body .btn-toggle-nav a.active { color: $link-color-dark; } -body.dark .navbar-light .navbar-text a { +[data-dark-mode] body .navbar-light .navbar-text a { color: $navbar-dark-active-color; } -body.dark .docs-links h3.sidebar-link a, -body.dark .page-links h3.sidebar-link a { +[data-dark-mode] body .docs-links h3.sidebar-link a, +[data-dark-mode] body .page-links h3.sidebar-link a { color: $body-color-dark; } -body.dark .navbar-light .navbar-text a:hover, -body.dark .navbar-light .navbar-text a:focus { +[data-dark-mode] body .navbar-light .navbar-text a:hover, +[data-dark-mode] body .navbar-light .navbar-text a:focus { color: $navbar-dark-active-color; } -body.dark .navbar .btn-link { +[data-dark-mode] body .navbar .btn-link { color: $navbar-dark-color; } -body.dark .content .btn-link { +[data-dark-mode] body .content .btn-link { color: $link-color-dark; } -body.dark .content .btn-link:hover { +[data-dark-mode] body .content .btn-link:hover { color: $link-color-dark; } -body.dark .navbar .btn-link:hover { +[data-dark-mode] body .content img[src^="https://latex.codecogs.com/svg.latex"] { + filter: invert(1); +} + +[data-dark-mode] body .navbar .btn-link:hover { color: $navbar-dark-hover-color; } -body.dark .navbar .btn-link:active { +[data-dark-mode] body .navbar .btn-link:active { color: $navbar-dark-active-color; } -body.dark .form-control.is-search { +[data-dark-mode] body .form-control.is-search { background: $body-overlay-dark; + border: 1px solid transparent; + color: $gray-300; /* background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='20' height='20' viewBox='0 0 24 24' fill='none' stroke='%236c757d' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='feather feather-search'%3E%3Ccircle cx='11' cy='11' r='8'%3E%3C/circle%3E%3Cline x1='21' y1='21' x2='16.65' y2='16.65'%3E%3C/line%3E%3C/svg%3E"); @@ -199,209 +261,274 @@ body.dark .form-control.is-search { */ } -body.dark .navbar-form::after { +[data-dark-mode] body .form-control.is-search:focus { + border: 1px solid $link-color-dark; +} + +[data-dark-mode] body .doks-search::after { + color: $gray-300; + border: 1px solid $gray-700; +} + +[data-dark-mode] body .text-dark { + color: $body-color-dark !important; +} + +/* +[data-dark-mode] body .navbar-form::after { color: $gray-600; border: 1px solid $gray-800; } +*/ -body.dark .form-control { - color: $gray-500; +[data-dark-mode] body .form-control { + color: $gray-300; } -body.dark .form-control:focus { - box-shadow: 0 0 0 0.2rem $focus-color-dark; +[data-dark-mode] body .form-control::placeholder { + color: $gray-400; + opacity: 1; } -body.dark .border-top { +[data-dark-mode] body .border-top { border-top: 1px solid $border-dark !important; } @include media-breakpoint-up(lg) { - body.dark .docs-sidebar { + [data-dark-mode] body .docs-sidebar { order: 0; - border-right: 1px solid $border-dark; } } -body.dark .docs-navigation { +[data-dark-mode] body .docs-navigation { border-top: 1px solid $border-dark; } -body.dark pre code::-webkit-scrollbar-thumb { +[data-dark-mode] body pre code::-webkit-scrollbar-thumb { background: $gray-400; } -body.dark pre code:hover { +[data-dark-mode] body code:not(.hljs) { + background: $body-overlay-dark; + color: $body-color-dark; +} + +[data-dark-mode] body pre code:hover { scrollbar-width: thin; scrollbar-color: $border-dark transparent; } -body.dark pre code::-webkit-scrollbar-thumb:hover { +[data-dark-mode] body pre code::-webkit-scrollbar-thumb:hover { background: $gray-500; } -body.dark code:not(.hljs):not(.language-mermaid) { - background: $body-overlay-dark; - color: $body-color-dark; -} - -body.dark .mermaid, -body.dark pre code.language-mermaid { - background: $white; -} - -body.dark blockquote { +[data-dark-mode] body blockquote { border-left: 3px solid $border-dark; } -body.dark .footer { - border-top: 1px solid $border-dark; +[data-dark-mode] body .footer { + border-top: 0px solid $border-dark; } -body.dark .docs-links, -body.dark .docs-toc { +[data-dark-mode] body .docs-links, +[data-dark-mode] body .docs-toc { scrollbar-width: thin; scrollbar-color: $body-bg-dark $body-bg-dark; } -body.dark .docs-links::-webkit-scrollbar, -body.dark .docs-toc::-webkit-scrollbar { +[data-dark-mode] body .docs-links::-webkit-scrollbar, +[data-dark-mode] body .docs-toc::-webkit-scrollbar { width: 5px; } -body.dark .docs-links::-webkit-scrollbar-track, -body.dark .docs-toc::-webkit-scrollbar-track { +[data-dark-mode] body .docs-links::-webkit-scrollbar-track, +[data-dark-mode] body .docs-toc::-webkit-scrollbar-track { background: $body-bg-dark; } -body.dark .docs-links::-webkit-scrollbar-thumb, -body.dark .docs-toc::-webkit-scrollbar-thumb { +[data-dark-mode] body .docs-links::-webkit-scrollbar-thumb, +[data-dark-mode] body .docs-toc::-webkit-scrollbar-thumb { background: $body-bg-dark; } -body.dark .docs-links:hover, -body.dark .docs-toc:hover { +[data-dark-mode] body .docs-links:hover, +[data-dark-mode] body .docs-toc:hover { scrollbar-width: thin; scrollbar-color: $border-dark $body-bg-dark; } -body.dark .docs-links:hover::-webkit-scrollbar-thumb, -body.dark .docs-toc:hover::-webkit-scrollbar-thumb { +[data-dark-mode] body .docs-links:hover::-webkit-scrollbar-thumb, +[data-dark-mode] body .docs-toc:hover::-webkit-scrollbar-thumb { background: $border-dark; } -body.dark .docs-links::-webkit-scrollbar-thumb:hover, -body.dark .docs-toc::-webkit-scrollbar-thumb:hover { +[data-dark-mode] body .docs-links::-webkit-scrollbar-thumb:hover, +[data-dark-mode] body .docs-toc::-webkit-scrollbar-thumb:hover { background: $border-dark; } -body.dark .docs-links h3:not(:first-child) { +[data-dark-mode] body .docs-links h3:not(:first-child) { border-top: 1px solid $border-dark; } -body.dark a.docs-link { +[data-dark-mode] body a.docs-link { color: $body-color-dark; } -body.dark .page-links li:not(:first-child) { +[data-dark-mode] body .page-links li:not(:first-child) { border-top: 1px dashed $border-dark; } -body.dark .card { +[data-dark-mode] body .card { background: $body-bg-dark; border: 1px solid $border-dark; color: white; } -body.dark .card.bg-light { +[data-dark-mode] body .card.bg-light { background: $body-overlay-dark !important; } -body.dark .navbar .menu-icon .navicon { +[data-dark-mode] body .navbar .menu-icon .navicon { background: $navbar-dark-color; } -body.dark .navbar .menu-icon .navicon::before, -body.dark .navbar .menu-icon .navicon::after { +[data-dark-mode] body .navbar .menu-icon .navicon::before, +[data-dark-mode] body .navbar .menu-icon .navicon::after { background: $navbar-dark-color; } -body.dark .logo-light { +[data-dark-mode] body .logo-light { display: none !important; } -body.dark .logo-dark { +[data-dark-mode] body .logo-dark { display: inline-block !important; } -body.dark .bg-light { +[data-dark-mode] body .bg-light { background: darken($body-bg-dark, 1.5%) !important; } -body.dark .bg-dots { +[data-dark-mode] body .bg-dots { background-image: radial-gradient($dots-dark 15%, transparent 15%); } -body.dark .text-muted { +[data-dark-mode] body .text-muted { color: darken($body-color-dark, 7.5%) !important; } -body.dark .alert-primary { +[data-dark-mode] body .alert-primary { background: $link-color-dark; color: $body-bg-dark; } -body.dark .figure-caption { +[data-dark-mode] body .figure-caption { color: $body-color-dark; } -body.dark table { +[data-dark-mode] body table { @extend .table-dark; } -body.dark .copy-status::after { +[data-dark-mode] body .copy-status::after { content: "Copy"; display: block; color: $body-color-dark; } -body.dark .copy-status:hover::after { +[data-dark-mode] body .copy-status:hover::after { content: "Copy"; display: block; color: $link-color-dark; } -body.dark .copy-status:focus::after, -body.dark .copy-status:active::after { +[data-dark-mode] body .copy-status:focus::after, +[data-dark-mode] body .copy-status:active::after { content: "Copied"; display: block; color: $link-color-dark; } -//Custom +/* +[data-dark-mode] body .dropdown-toggle:focus, +[data-dark-mode] body .doks-sidebar-toggle:focus { + box-shadow: 0 0 0 0.2rem $focus-color-dark; +} +*/ -body.dark .alert-global a { - color: $body-color-dark; +[data-dark-mode] body .offcanvas { + background-color: $body-bg-dark; } -body.dark .alert-global { - background: $primary; - opacity: 0.975; - color: $body-color-dark; - border: 1px solid $border-dark !important; + +[data-dark-mode] body .btn-close { + background-image: url("data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IiNkZWUyZTYiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBjbGFzcz0iZmVhdGhlciBmZWF0aGVyLXgiPjxsaW5lIHgxPSIxOCIgeTE9IjYiIHgyPSI2IiB5Mj0iMTgiPjwvbGluZT48bGluZSB4MT0iNiIgeTE9IjYiIHgyPSIxOCIgeTI9IjE4Ij48L2xpbmU+PC9zdmc+"); + background-size: 1.5rem; } -body.dark .support-card -{ - background: #1b1f22; +@include media-breakpoint-up(md) { + [data-dark-mode] body .alert-dismissible .btn-close { + background-size: 1.25rem; + } } -body.dark .section-sm -{ - background: #1b1f22; +/* +[data-dark-mode] body .btn-close:focus { + box-shadow: 0 0 0 0.2rem $focus-color-dark; } +*/ -body.dark .stretched-link -{ - color: whitesmoke; +[data-dark-mode] .dropdown-item { + color: $body-bg-dark; } +[data-dark-mode] body hr.text-black-50 { + color: $gray-600 !important; +} + +[data-dark-mode] body .email-form .form-control { + background: $body-overlay-dark; + border: 1px solid transparent; +} + +[data-dark-mode] body .email-form .form-control:focus { + border: 1px solid $link-color-dark; +} + +[data-dark-mode] .page-link { + color: $link-color-dark; + background-color: transparent; + border: $pagination-border-width solid $border-dark; + + &:hover { + color: $body-bg-dark; + background-color: $body-color-dark; + border-color: $body-color-dark; + } + + &:focus { + color: $body-bg-dark; + background-color: $body-color-dark; + } +} + +[data-dark-mode] .page-item { + &.active .page-link { + color: $body-bg-dark; + + @include gradient-bg($link-color-dark); + + border-color: $link-color-dark; + } + + &.disabled .page-link { + color: $pagination-disabled-color; + background-color: $body-overlay-dark; + border-color: $border-dark; + } +} + +[data-dark-mode] .stretched-link +{ + color: white; +} diff --git a/assets/scss/common/_fonts.scss b/assets/scss/common/_fonts.scss index d2b77252..5f21b169 100644 --- a/assets/scss/common/_fonts.scss +++ b/assets/scss/common/_fonts.scss @@ -1,6 +1,6 @@ /* jost-regular - latin */ @font-face { - font-family: "Jost"; + font-family: Jost; font-style: normal; font-weight: 400; font-display: swap; @@ -12,7 +12,7 @@ /* jost-500 - latin */ @font-face { - font-family: "Jost"; + font-family: Jost; font-style: normal; font-weight: 500; font-display: swap; @@ -24,7 +24,7 @@ /* jost-700 - latin */ @font-face { - font-family: "Jost"; + font-family: Jost; font-style: normal; font-weight: 700; font-display: swap; @@ -36,7 +36,7 @@ /* jost-italic - latin */ @font-face { - font-family: "Jost"; + font-family: Jost; font-style: italic; font-weight: 400; font-display: swap; @@ -48,7 +48,7 @@ /* jost-500italic - latin */ @font-face { - font-family: "Jost"; + font-family: Jost; font-style: italic; font-weight: 500; font-display: swap; @@ -60,7 +60,7 @@ /* jost-700italic - latin */ @font-face { - font-family: "Jost"; + font-family: Jost; font-style: italic; font-weight: 700; font-display: swap; diff --git a/assets/scss/common/_global.scss b/assets/scss/common/_global.scss index ae6ec646..8705b898 100644 --- a/assets/scss/common/_global.scss +++ b/assets/scss/common/_global.scss @@ -9,23 +9,8 @@ padding-bottom: 3rem; } -::-webkit-scrollbar { - width: 2px!important; -} - -/* Track */ -::-webkit-scrollbar-track { - background: #f1f1f1!important; -} - -/* Handle */ -::-webkit-scrollbar-thumb { - background: rgb(209, 209, 209)!important; -} - -/* Handle on hover */ -::-webkit-scrollbar-thumb:hover { - background: rgb(97, 97, 97)!important; +.content img { + max-width: 100%; } h1, @@ -43,10 +28,27 @@ h6, margin: 2rem 0 1rem; } +.offcanvas-header { + border-bottom: 1px solid $gray-300; + padding-top: 1.0625rem; + padding-bottom: 0.8125rem; +} + +h5.offcanvas-title { + margin: 0; +} + +body.docs { + padding-top: 0 !important; +} + @include media-breakpoint-up(md) { body { font-size: $font-size-md; + + /* padding-top: 4rem !important; + */ } h1, @@ -65,11 +67,11 @@ h6, } } - .home h1 { /* font-size: calc(1.375rem + 1.5vw); */ font-size: calc(1.875rem + 1.5vw); } + a:hover, a:focus { text-decoration: none; @@ -92,7 +94,7 @@ a.btn:focus { .section-sm { padding-top: 1rem; - padding-bottom: 1rem; + padding-bottom: 2rem; } /* @@ -104,9 +106,11 @@ a.btn:focus { } */ +/* body { padding-top: 3.5625rem; } +*/ .docs-sidebar { order: 2; @@ -115,7 +119,6 @@ body { @include media-breakpoint-up(lg) { .docs-sidebar { order: 0; - border-right: 1px solid $gray-200; } @supports ((position:-webkit-sticky) or (position:sticky)) { @@ -179,7 +182,7 @@ body { .docs-navigation { border-top: 1px solid $gray-200; margin-top: 2rem; - margin-bottom: 2rem; + margin-bottom: 0; padding-top: 2rem; } @@ -188,6 +191,10 @@ body { } @include media-breakpoint-up(lg) { + .docs-navigation { + margin-bottom: -1rem; + } + .docs-navigation a { font-size: $font-size-base; } @@ -204,7 +211,7 @@ body { } ::selection { - background: rgba(212, 53, 159, 0.2); + background: #4caf5014; } .bg-dots { @@ -243,56 +250,46 @@ body { font-size: $font-size-md; } +.card-bar { + border-top: 4px solid; + border-image-source: linear-gradient(90deg, $primary, #8ed6fb 50%, #d32e9d); + border-image-slice: 1; +} -@media screen and (max-width: 1920px) { - .navbar-form { - margin-left: 60%!important; - } +.modal-backdrop { + background-color: #fff; } -@media screen and (max-width: 1400px) { - .navbar-form { - margin-left: 40%!important; - } + +.modal-backdrop.show { + opacity: 0.7; } -@media screen and (max-width: 906px) { - .navbar-form { - margin-left: 0%!important; + +@include media-breakpoint-up(md) { + .modal-backdrop.show { + opacity: 0; } } -.navbar -{ - margin-top: 0px!important; - border-bottom: 0px!important; - box-shadow: 0px 10px 60px 0px rgba(29,29,31,0.05) !important; -} -.docs-links -{ - overflow: auto!important; -} -.docs .alert { - margin: 0px!important; + +::-webkit-scrollbar { + width: 3px!important; } -.docs-sidebar -{ - border: none; + + +/* Handle */ +::-webkit-scrollbar-thumb { + background: rgb(185, 185, 185)!important; } -.support-card -{ - padding: 40px; - text-align: center; - background: whitesmoke; +/* Handle on hover */ +::-webkit-scrollbar-thumb:hover { + background: rgb(97, 97, 97)!important; } -.tech-card +.support-card { padding: 40px; text-align: center; -} - -.section-sm -{ - background: whitesmoke; + margin-top: 40px!important; } .card { @@ -311,33 +308,51 @@ body { color: black; } -.navbar-nav +.btn { - justify-content: center; + font-size: small!important; } -.nav-link +.tech-card { - padding: 0; + padding: 40px; + text-align: center; } -.primary-text + +.feature-card { - color: $primary; + text-align: left!important; + margin:10px!important; } -h3, .h3 { - font-size: 1.4rem; +.code-green +{ + color:#3eaf7c!important; } -h4, .h4 { - font-size: 1.3rem; +.tablet +{ + background: $primary; + border-radius: 10px; + color: white; + width: fit-content; + padding: 5px; + font-size: 13px; + margin-right: 10px; +} +.tablet-secondary +{ + background: $secondary; } -h5, .h5 { - font-size: 1.2rem; +.tablet-group +{ + margin-bottom: 10px; + display: flex; } -.doc-img{ - width: 85%!important; - height: auto; +.nav-topic-header +{ + font-weight: 500; + color: $primary; } diff --git a/assets/scss/common/_variables.scss b/assets/scss/common/_variables.scss index 03216d89..c1c396b2 100644 --- a/assets/scss/common/_variables.scss +++ b/assets/scss/common/_variables.scss @@ -15,21 +15,20 @@ $black: #000; $yellow: #ffe000; $black: #1d2d35; $beige: #fbf7f0; -$red: #e55235; + $purple: #5d2f86; $brown: #aa9c84; -$blue: #009eec; +$green: #3eaf7c; $blue-300: #8ed6fb; +$pink-100: #fcfaff; $pink-500: #d32e9d; -$green :#3eaf7c; -$transparentgreen : #3eaf7c17; - $primary: $green; +$secondary : $pink-500; -$color-btn-bg: $pink-500; -$color-btn-border: darken($pink-500, 5%); +$color-btn-bg: $primary; +$color-btn-border: darken($primary, 5%); $color-btn-text: $white; // Options @@ -38,7 +37,7 @@ $color-btn-text: $white; $enable-caret: true; $enable-rounded: true; -$enable-shadows: true; +$enable-shadows: false; $enable-gradients: false; $enable-transitions: true; $enable-reduced-motion: true; @@ -59,7 +58,7 @@ $navbar-light-toggler-icon-bg: none; // // Quickly modify global styling by enabling or disabling optional features. - $enable-responsive-font-sizes: true; +// $enable-responsive-font-sizes: true; // Body // @@ -80,11 +79,11 @@ $link-decoration: none; // Define the maximum width of `.container` for different screen sizes. $container-max-widths: ( - sm: 95%, - md: 95%, - lg: 95%, - xl: 95%, - xxl: 95% + sm: 540px, + md: 720px, + lg: 960px, + xl: 1240px, + xxl: 1320px ); @include _assert-ascending($container-max-widths, "$container-max-widths"); @@ -119,12 +118,12 @@ $font-size-lg: $font-size-base * 1.25; $font-size-md: $font-size-base * 1.125; $font-size-sm: $font-size-base * 0.875; -$line-height-base: 1.5; +// $line-height-base: 1.5; $headings-font-family: null; -$headings-font-weight: 100; +$headings-font-weight: 400; -$lead-font-weight: 100; +$lead-font-weight: 300; // Spacing // @@ -163,3 +162,30 @@ $alert-border-width: 0; $alert-bg-scale: 0; $alert-border-scale: 0; $alert-color-scale: 0; + +// docsearch +$dropdown-config: ( + main-color: $purple, + layout-type: normal, + layout-width: normal, + layout-alignment: align, + background-color: $white, + border-radius: 4, + border-width: 1, + border-color: $gray-200, + box-shadow: none, + branding-position: bottom, + spacing: normal, + include-desc: yes, + background-category-header: $white, + font-size: normal, + header-color: $black, + title-color: $black, + subtitle-color: $black, + text-color: $black, + highlight-color: $purple, + highlight-opacity: 0.1, + highlight-type: underline +); + +$input-btn-focus-width: 0; diff --git a/assets/scss/components/_alerts.scss b/assets/scss/components/_alerts.scss index 91d84688..2d75ddda 100644 --- a/assets/scss/components/_alerts.scss +++ b/assets/scss/components/_alerts.scss @@ -1,40 +1,20 @@ .alert { - font-family: $font-family-monospace; font-size: $font-size-sm; + text-decoration: none; } -.alert-icon { - margin-right: 0.75rem; -} - -.docs .alert { - border-radius: 5px; +.docs main .alert { margin: 2rem -1.5rem; - margin-bottom: 12px!important; } .alert .alert-link { - text-decoration: underline; -} - -.alert-dark { - color: $white; - background-color: $black; + text-decoration: none; } -.alert-dark .alert-link { +.alert-doks { + background: $primary; color: $white; -} - -.alert-light { - color: $black; -} - -.alert-warning { - padding: 20px; - margin-bottom: 20px!important; - background: whitesmoke; - color: $black; + border-radius: 10px; } /* @@ -57,49 +37,125 @@ background-color: $primary; } +.alert a { + text-decoration: underline; +} + .alert-primary .alert-link { color: $white; } -.alert .alert-link:hover, -.alert .alert-link:focus { - text-decoration: none; +/* +.alert-primary { + color: #084298; + background-color: #cfe2ff; + border-color: #b6d4fe; } -.alert code { - background: darken($beige, 5%); - color: $black; - padding: 0.25rem 0.5rem; +.alert-primary .alert-link { + color: #06357a; } +*/ -.alert-global { - background-color: rgba(253, 253, 253, 0.95); - font-family: $font-family-base; +.alert-secondary { + color: #41464b; + background-color: #e2e3e5; + border-color: #d3d6d8; } -.alert-global a { - color: white; - text-decoration: none; +.alert-secondary .alert-link { + color: #34383c; } -.alert-global { - background: $primary; - color: white;} +.alert-success { + color: #0f5132; + background-color: #d1e7dd; + border-color: #badbcc; +} -@include media-breakpoint-up(sm) { - .alert-global { - margin: 0 0% 0rem; - } +.alert-success .alert-link { + color: #0c4128; +} + +.alert-info { + color: #055160; + background-color: #cff4fc; + border-color: #b6effb; +} + +.alert-info .alert-link { + color: #04414d; +} + +.alert-warning { + color: #664d03; + background-color: #fff3cd; + border-color: #ffecb5; +} + +.alert-warning .alert-link { + color: #523e02; +} + +.alert-danger { + color: #842029; + background-color: #f8d7da; + border-color: #f5c2c7; +} + +.alert-danger .alert-link { + color: #6a1a21; +} + +.alert-light { + color: #636464; + background-color: #fefefe; + border-color: #fdfdfe; +} + +.alert-light .alert-link { + color: #4f5050; +} + +.alert-dark { + color: #141619; + background-color: #d3d3d4; + border-color: #bcbebf; +} + +.alert-dark .alert-link { + color: #101214; +} + +.alert .alert-link:hover, +.alert .alert-link:focus { + text-decoration: none; +} + +.alert-dismissible .btn-close { + position: absolute; + top: 50%; + transform: translateY(-50%); + right: 1rem; + z-index: 2; + padding: 0.5rem; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='32' height='32' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='feather feather-x'%3E%3Cline x1='18' y1='6' x2='6' y2='18'%3E%3C/line%3E%3Cline x1='6' y1='6' x2='18' y2='18'%3E%3C/line%3E%3C/svg%3E"); + background-size: 1.5rem; + filter: invert(1) grayscale(100%) brightness(200%); } @include media-breakpoint-up(md) { - .alert-global { - margin: 0 0% 0rem; + .alert-dismissible .btn-close { + background-size: 1.25rem; } } -@include media-breakpoint-up(lg) { - .alert-global { - margin: 0 0% 0rem; - } +[data-global-alert="closed"] #announcement { + display: none; +} + +.alert code { + background: darken($beige, 5%); + color: $black; + padding: 0.25rem 0.5rem; } diff --git a/assets/scss/components/_buttons.scss b/assets/scss/components/_buttons.scss index fe35497a..657c4138 100644 --- a/assets/scss/components/_buttons.scss +++ b/assets/scss/components/_buttons.scss @@ -4,7 +4,9 @@ } #mode { - margin-right: 1.25rem; + padding-right: 0.25rem; + padding-left: 0.25rem; + margin-right: -0.25rem; } .btn-link:focus { @@ -18,21 +20,15 @@ @include media-breakpoint-up(md) { #mode { - margin-right: 0.5rem; + margin-left: 1.125rem; + margin-right: -0.375rem; } .navbar .btn-link { padding: 0.5625em 0.25rem 0.5rem 0.125rem; } } -.btn:focus { - color: white; - box-shadow:none!important; -} -.btn:active { - color: white; - box-shadow:none!important; -} + .navbar .btn-link:hover { color: $navbar-light-hover-color; } @@ -49,11 +45,11 @@ body .toggle-light { display: none; } -body.dark .toggle-light { +[data-dark-mode] body .toggle-light { display: block; } -body.dark .toggle-dark { +[data-dark-mode] body .toggle-dark { display: none; } @@ -69,7 +65,7 @@ pre { .btn-copy { transition: opacity 0.3s ease-in-out; - opacity: 0; + visibility: hidden !important; position: absolute; right: 0.25rem; top: 0.25rem; @@ -109,7 +105,7 @@ pre { @include media-breakpoint-up(md) { pre:hover .btn-copy { - opacity: 1; + visibility: visible !important; } } @@ -191,20 +187,37 @@ pre { color: $link-color; } -.btn-primary { - color: white; - font-size: small!important; - box-shadow: none!important; - transition: 0.3s; +.doks-navbar .dropdown-menu, +.doks-subnavbar .dropdown-menu { + font-size: 0.875rem; +} + +.doks-navbar .dropdown-item.current, +.doks-subnavbar .dropdown-item.current { + font-weight: 600; + background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'%3e%3cpath fill='%23292b2c' d='M2.3 6.73L.6 4.53c-.4-1.04.46-1.4 1.1-.8l1.1 1.4 3.4-3.8c.6-.63 1.6-.27 1.2.7l-4 4.6c-.43.5-.8.4-1.1.1z'/%3e%3c/svg%3e"); + background-repeat: no-repeat; + background-position: right 1rem top 0.6rem; + background-size: 0.75rem 0.75rem; } -.btn-primary:hover { - color: white; +.btn-close { + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='32' height='32' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='feather feather-x'%3E%3Cline x1='18' y1='6' x2='6' y2='18'%3E%3C/line%3E%3Cline x1='6' y1='6' x2='18' y2='18'%3E%3C/line%3E%3C/svg%3E"); + background-size: 1.5rem; } -.btn:active {outline: 0 !important;;} +.offcanvas-header .btn-close { + margin-right: 0 !important; +} + +.dropdown-toggle::after { + display: none; +} -a:hover, a:visited, a:link, a:active -{ - text-decoration: none!important; +.dropdown-caret { + margin-left: -0.1875rem; + margin-right: -0.3125rem; +} +.btn-primary { + color: $white !important; } diff --git a/assets/scss/components/_code.scss b/assets/scss/components/_code.scss index ff743c27..969c159c 100644 --- a/assets/scss/components/_code.scss +++ b/assets/scss/components/_code.scss @@ -8,7 +8,7 @@ samp { } code { - background: $transparentgreen; + background: rgba(62,175,124,0.0901961); color: $black; padding: 0.25rem 0.5rem; } @@ -28,7 +28,7 @@ pre code { } .hljs { - padding: 1.25rem 1.5rem; + padding: 1.5rem !important; } @include media-breakpoint-down(sm) { diff --git a/assets/scss/components/_search.scss b/assets/scss/components/_search.scss index 3a70b2b1..cb82c6f1 100644 --- a/assets/scss/components/_search.scss +++ b/assets/scss/components/_search.scss @@ -4,16 +4,21 @@ #suggestions { position: absolute; - right: 0; + left: 0; margin-top: 0.5rem; width: calc(100vw - 3rem); + z-index: $zindex-dropdown; +} + +#suggestions a, +.suggestion__no-results { + padding: 0.75rem; + margin: 0 0.5rem; } #suggestions a { display: block; text-decoration: none; - padding: 0.75rem; - margin: 0 0.5rem; } #suggestions a:focus { @@ -42,34 +47,36 @@ font-size: $font-size-base; } -#suggestions span:first-child { +.suggestion__title { font-weight: $headings-font-weight; color: $black; } -#suggestions span:nth-child(2) { +.suggestion__description, +.suggestion__no-results { color: $gray-700; } @include media-breakpoint-up(sm) { #suggestions { - width: 30rem; + width: 31.125rem; } #suggestions a { display: flex; } - #suggestions span:first-child { + .suggestion__title { width: 9rem; padding-right: 1rem; border-right: 1px solid $gray-200; display: inline-block; - text-align: right; + text-align: left; } - #suggestions span:nth-child(2) { + .suggestion__description { width: 19rem; padding-left: 1rem; + font-style: italic; } } diff --git a/assets/scss/components/_syntax.scss b/assets/scss/components/_syntax.scss index f054f38c..b936146e 100644 --- a/assets/scss/components/_syntax.scss +++ b/assets/scss/components/_syntax.scss @@ -8,7 +8,7 @@ Based on Ascetic by (c) Ivan Sagalaev display: block; overflow-x: auto; padding: 1.25rem 1.5rem; - background: $transparentgreen; + background: rgba(62, 175, 124, 0.0901961); color: $body-color; } @@ -44,19 +44,19 @@ Based on Ascetic by (c) Ivan Sagalaev font-style: italic; } -body.dark .hljs { +[data-dark-mode] body .hljs { background: $body-overlay-dark; color: $body-color-dark; } -body.dark .hljs-string, -body.dark .hljs-variable, -body.dark .hljs-template-variable, -body.dark .hljs-symbol, -body.dark .hljs-bullet, -body.dark .hljs-section, -body.dark .hljs-addition, -body.dark .hljs-attribute, -body.dark .hljs-link { +[data-dark-mode] body .hljs-string, +[data-dark-mode] body .hljs-variable, +[data-dark-mode] body .hljs-template-variable, +[data-dark-mode] body .hljs-symbol, +[data-dark-mode] body .hljs-bullet, +[data-dark-mode] body .hljs-section, +[data-dark-mode] body .hljs-addition, +[data-dark-mode] body .hljs-attribute, +[data-dark-mode] body .hljs-link { color: $blue-300; } diff --git a/assets/scss/layouts/_footer.scss b/assets/scss/layouts/_footer.scss index 7d218114..42dd5e1a 100644 --- a/assets/scss/layouts/_footer.scss +++ b/assets/scss/layouts/_footer.scss @@ -1,5 +1,4 @@ .footer { - border-top: 1px solid $gray-200; padding-top: 1.125rem; padding-bottom: 1.125rem; } diff --git a/assets/scss/layouts/_header.scss b/assets/scss/layouts/_header.scss index e8d50f36..0702c7aa 100644 --- a/assets/scss/layouts/_header.scss +++ b/assets/scss/layouts/_header.scss @@ -14,6 +14,7 @@ font-weight: $headings-font-weight; } +/* .navbar-light .navbar-brand, .navbar-light .navbar-brand:hover, .navbar-light .navbar-brand:active { @@ -23,6 +24,23 @@ .navbar-light .navbar-nav .active .nav-link { color: $primary; } +*/ + +.navbar { + z-index: 1000; + background-color: rgba(255, 255, 255, 0.95); + border-bottom: 1px solid $gray-200; + + /* + margin-top: 4px; + */ +} + +@include media-breakpoint-up(lg) { + .navbar { + z-index: 1025; + } +} @include media-breakpoint-up(md) { .navbar-brand { @@ -39,7 +57,7 @@ } .nav-item { - margin-left: 1.25rem; + margin-left: 0; } @include media-breakpoint-up(md) { @@ -48,11 +66,13 @@ } } +/* @include media-breakpoint-down(sm) { .nav-item:first-child { margin-left: 0; } } +*/ @include media-breakpoint-down(md) { .navbar .container { @@ -66,11 +86,52 @@ height: 0; } +button#doks-languages { + margin-right: -0.5625rem; + margin-left: 0.75rem; +} + +button#doks-versions { + margin-right: -0.5625rem; + margin-left: 0; +} + +.offcanvas .nav-link { + color: $body-color; +} + +.doks-subnavbar { + background-color: rgba(255, 255, 255, 0.95); + border-bottom: 1px solid $gray-200; +} + +.doks-subnavbar .nav-link { + padding: 0.5rem 1.5rem 0.5rem 0; +} + +.doks-subnavbar .nav-link:first-child { + padding: 0.5rem 1.5rem 0.5rem 0; +} + +.offcanvas .nav-link:hover, +.offcanvas .nav-link:focus { + color: $link-color; +} + +.offcanvas .nav-link.active { + background: $link-color; + color: $white; + border-radius: 38px; + width: fit-content; +} + +/* .navbar { background-color: rgba(255, 255, 255, 0.95); border-bottom: 1px solid $gray-200; margin-top: 4px; } +*/ .header-bar { border-top: 4px solid; @@ -78,18 +139,24 @@ border-image-slice: 1; } +.offcanvas .header-bar { + margin-bottom: -4px; +} + .home .navbar { border-bottom: 0; } +/* .navbar-form { position: relative; margin-top: 0.25rem; } +*/ @include media-breakpoint-up(md) { .navbar-brand { - margin-right: 1rem !important; + margin-right: 0.75rem !important; } .main-nav .nav-item:first-child .nav-link, @@ -102,13 +169,49 @@ padding-right: 0; } + .doks-search { + max-width: 20rem; + margin-top: 0.125rem; + margin-bottom: 0.125rem; + } + + /* .navbar-form { margin-top: 0; margin-left: 6rem; margin-right: 1.5rem; } + */ } +.form-control.is-search { + padding-right: 4rem; + border: 1px solid $gray-300; + background: $gray-100; +} + +.form-control.is-search:focus { + border: 1px solid $primary; +} + +.doks-search::after { + position: absolute; + top: 0.4625rem; + right: 0.5375rem; + display: flex; + align-items: center; + justify-content: center; + height: 1.5rem; + padding-right: 0.3125rem; + padding-left: 0.3125rem; + font-size: $font-size-base * 0.75; + color: $gray-700; + content: "Ctrl + /"; + border: 1px solid $gray-300; + border-radius: 0.25rem; +} + +/* @include media-breakpoint-up(lg) { .navbar-form { margin-left: 15rem; @@ -120,23 +223,34 @@ margin-left: 30rem; } } +*/ +/* .form-control.is-search { - /* +*/ + +/* padding-right: calc(1.5em + 0.75rem); */ + +/* padding-right: 2.5rem; background: $gray-100; border: 0; + */ - /* +/* background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='20' height='20' viewBox='0 0 24 24' fill='none' stroke='%236c757d' stroke-width='2' stroke-linecap='round' stroke-linejoin='round' class='feather feather-search'%3E%3Ccircle cx='11' cy='11' r='8'%3E%3C/circle%3E%3Cline x1='21' y1='21' x2='16.65' y2='16.65'%3E%3C/line%3E%3C/svg%3E"); background-repeat: no-repeat; background-position: right calc(0.375em + 0.1875rem) center; background-size: calc(0.75em + 0.375rem) calc(0.75em + 0.375rem); */ + +/* } +*/ +/* .navbar-form::after { position: absolute; top: 0.4625rem; @@ -153,14 +267,13 @@ border: 1px solid $gray-300; border-radius: 0.25rem; } +*/ /*! purgecss start ignore */ .algolia-autocomplete { display: flex !important; } -input:focus { - box-shadow:none!important; -} + .algolia-autocomplete .ds-dropdown-menu { box-shadow: 0 0.5rem 1rem rgba(0, 0, 0, 0.15) !important; } @@ -172,12 +285,20 @@ input:focus { width: auto !important; } + .algolia-autocomplete .algolia-docsearch-suggestion .algolia-docsearch-suggestion--subcategory-column { + font-weight: normal; + } + .algolia-autocomplete .algolia-docsearch-suggestion .algolia-docsearch-suggestion--subcategory-column::after { - content: "|"; + content: "/"; margin-right: 0.25rem; } } +.algolia-autocomplete .algolia-docsearch-suggestion--category-header { + color: $black; +} + .algolia-autocomplete .algolia-docsearch-suggestion--title { margin-bottom: 0; } @@ -268,3 +389,60 @@ input:focus { .navbar .menu-btn:checked ~ .menu-icon:not(.steps) .navicon::after { top: 0; } + +.btn-menu { + margin-left: 1rem; +} + +.btn-menu, +.doks-sidebar-toggle { + padding-right: 0.25rem; + padding-left: 0.25rem; + margin-right: -0.5rem; +} + +.btn-menu:hover, +.btn-doks-light:hover, +.doks-sidebar-toggle:hover { + background: $pink-100; +} + +.btn-menu:focus, +.doks-sidebar-toggle:focus, +.doks-mode-toggle:focus { + outline: 0; +} + +.doks-sidebar-toggle .doks-collapse { + display: none; +} + +.doks-sidebar-toggle:not(.collapsed) .doks-expand { + display: none; +} + +.doks-sidebar-toggle:not(.collapsed) .doks-collapse { + display: inline-block; +} + +.navbar-light .navbar-brand, +.navbar-light .navbar-brand:hover, +.navbar-light .navbar-brand:active { + color: $body-color; +} + +.navbar-light .navbar-nav .active .nav-link { + color: $primary; +} + +.dropdown-divider { + border-top: 1px dashed $gray-200; +} + +.dropdown-item:hover { + background: $gray-100; +} + +.dropdown-item:active { + color: inherit; +} diff --git a/assets/scss/layouts/_pages.scss b/assets/scss/layouts/_pages.scss index 8938dbc1..405ede95 100644 --- a/assets/scss/layouts/_pages.scss +++ b/assets/scss/layouts/_pages.scss @@ -9,7 +9,6 @@ .anchor { visibility: hidden; - padding-left: 0.5rem; } h1:hover a, @@ -24,13 +23,29 @@ h4:hover a { margin-top: 2.25rem; } -.edit-page { +.page-footer-meta { margin-top: 3rem; - font-size: $font-size-base; } -.edit-page svg { - margin-right: 0.5rem; +.edit-page, +.last-modified { + font-size: $font-size-sm; + margin-top: 0.25rem; + margin-bottom: 0.25rem; +} + +@include media-breakpoint-up(md) { + .edit-page, + .last-modified { + font-size: $font-size-base; + margin-top: 0.75rem; + margin-bottom: 0.25rem; + } +} + +.edit-page svg, +.last-modified svg { + margin-right: 0.25rem; margin-bottom: 0.25rem; } @@ -43,3 +58,7 @@ p.meta { margin-top: 2.25rem; font-size: $font-size-base; } + +.page-link:hover { + text-decoration: none; +} diff --git a/assets/scss/layouts/_posts.scss b/assets/scss/layouts/_posts.scss index 71dbed1f..da276605 100644 --- a/assets/scss/layouts/_posts.scss +++ b/assets/scss/layouts/_posts.scss @@ -19,6 +19,7 @@ } .blog-header { + text-align: center; margin-bottom: 2rem; } diff --git a/assets/scss/layouts/_sidebar.scss b/assets/scss/layouts/_sidebar.scss index 46881bd0..2a48a5fe 100644 --- a/assets/scss/layouts/_sidebar.scss +++ b/assets/scss/layouts/_sidebar.scss @@ -39,15 +39,15 @@ .page-links h3 { text-transform: uppercase; font-size: $font-size-base; - margin: 1.25rem 0 0.5rem 0; - padding: 1.5rem 0 0 0; + margin: 1.25rem 0 0.5rem; + padding: 1.5rem 0 0; } @include media-breakpoint-up(lg) { .docs-links h3, .page-links h3 { margin: 1.125rem 1.5rem 0.75rem 0; - padding: 1.375rem 0 0 0; + padding: 1.375rem 0 0; } } diff --git a/config/_default/config.toml b/config/_default/config.toml index 738d2dd8..1875dec7 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -10,6 +10,11 @@ paginate = 7 rssLimit = 10 googleAnalytics = "G-V1XWX7CJF6" +# Multilingual +defaultContentLanguage = "en" +disableLanguages = ["de", "nl"] +# defaultContentLanguageInSubdir = true + # add redirects/headers [outputs] home = ["HTML", "RSS", "REDIRECTS", "HEADERS"] @@ -43,28 +48,10 @@ isPlainText = true noUgly = true rel = "sitemap" -[markup] - [markup.goldmark] - [markup.goldmark.extensions] - linkify = true - [markup.goldmark.parser] - autoHeadingID = true - autoHeadingIDType = "github" - [markup.goldmark.parser.attribute] - block = true - title = true - [markup.goldmark.renderer] - unsafe = true - [markup.highlight] - codeFences = false - guessSyntax = true - hl_Lines = "" - lineNoStart = 1 - lineNos = false - lineNumbersInTable = false - noClasses = true - style = "dracula" - tabWidth = 4 +[caches] + [caches.getjson] + dir = ":cacheDir/:project" + maxAge = "10s" [sitemap] changefreq = "daily" @@ -76,6 +63,7 @@ rel = "sitemap" [permalinks] blog = "/blog/:title/" +# docs = "/docs/1.0/:sections[1:]/:title/" [minify.tdewolff.html] keepWhitespace = false @@ -100,8 +88,3 @@ rel = "sitemap" [[module.mounts]] source = "node_modules/mermaid" target = "assets/js/vendor/mermaid" - -[imaging] -resampleFilter = "Lanczos" -quality = 100 -anchor = "smart" diff --git a/config/_default/languages.toml b/config/_default/languages.toml new file mode 100644 index 00000000..1f0ca3eb --- /dev/null +++ b/config/_default/languages.toml @@ -0,0 +1,25 @@ +[en] + languageName = "English" + contentDir = "content/en" + weight = 10 + [en.params] + languageISO = "EN" + +[de] + languageName = "German" + contentDir = "content/de" + weight = 15 + [de.params] + languageISO = "DE" + +[nl] + languageName = "Nederlands" + contentDir = "content/nl" + weight = 20 + [nl.params] + languageISO = "NL" + titleAddition = "Modern documentatie-thema" + description = "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard." + titleHome = "Doks thema" + footer = "Mogelijk gemaakt door Netlify, Hugo, en Doks" + alertText = "Introductie van het Doks-kinderthema, verschillende DX + UX-updates en meer! Bekijk Doks v0.2" diff --git a/config/_default/markup.toml b/config/_default/markup.toml new file mode 100644 index 00000000..2880e305 --- /dev/null +++ b/config/_default/markup.toml @@ -0,0 +1,29 @@ +defaultMarkdownHandler = "goldmark" + +[goldmark] + [goldmark.extensions] + linkify = false + [goldmark.parser] + autoHeadingID = true + autoHeadingIDType = "github" + [goldmark.parser.attribute] + block = true + title = true + [goldmark.renderer] + unsafe = true + +[highlight] + codeFences = false + guessSyntax = false + hl_Lines = "" + lineNoStart = 1 + lineNos = false + lineNumbersInTable = true + noClasses = false + style = "dracula" + tabWidth = 4 + +[tableOfContents] + endLevel = 3 + ordered = false + startLevel = 2 diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml new file mode 100644 index 00000000..e0fd4b6f --- /dev/null +++ b/config/_default/menus/menus.en.toml @@ -0,0 +1,64 @@ +[[main]] + name = "Contact" + url = "/contact/" + weight = 50 + +[[main]] + name = "Basics" + url = "/basics/getting-started/" + weight = 10 + +############################## + +[[main]] + name = ".NET 7 API đŸ”Ĩ" + url = "/dotnet-webapi-boilerplate/general/getting-started/" + weight = 20 + +[[main]] + name = "Microservices (soon)" + url = "/dotnet-microservices-boilerplate/" + weight = 30 + +[[dotnet-webapi-boilerplate]] + name = "General" + weight = 20 + identifier = "general" + url = "/dotnet-webapi-boilerplate/general/" + +[[dotnet-webapi-boilerplate]] + name = "Fundamentals" + weight = 30 + identifier = "fundamentals" + url = "/dotnet-webapi-boilerplate/fundamentals/" + +[[dotnet-webapi-boilerplate]] + name = "Tutorials" + weight = 40 + identifier = "tutorials" + url = "/dotnet-webapi-boilerplate/tutorials/" + +#################################### + +[[main]] + name = "Blazor" + url = "/blazor-webassembly-boilerplate/general/getting-started/" + weight = 40 + +[[social]] + name = "GitHub" + pre = "" + url = "https://github.com/fullstackhero" + post = "v0.1.0" + weight = 10 + +[[social]] + name = "Twitter" + pre = "" + url = "https://twitter.com/iammukeshm" + weight = 20 + +[[footer]] + name = "Privacy" + url = "/privacy-policy/" + weight = 10 diff --git a/config/_default/menus.toml b/config/_default/menus/menus.nl.toml similarity index 74% rename from config/_default/menus.toml rename to config/_default/menus/menus.nl.toml index 25fb4e2b..e530352a 100644 --- a/config/_default/menus.toml +++ b/config/_default/menus/menus.nl.toml @@ -1,32 +1,36 @@ -[[main]] - name = "WebApi" +[[docs]] + name = "Prologue" weight = 10 - identifier = "dotnet-webapi-boilerplate" - url = "/dotnet-webapi-boilerplate" - -[[webapi]] - name = "General" - weight = 20 - identifier = "general" - url = "/dotnet-webapi-boilerplate/general/" + identifier = "prologue" + url = "/docs/prologue/" -[[webapi]] - name = "Tutorials" - weight = 21 - identifier = "tutorials" - url = "/dotnet-webapi-boilerplate/tutorials/" +[[docs]] + name = "Help" + weight = 60 + identifier = "help" + url = "/docs/help/" -[[social]] - name = "Twitter" - pre = "" - url = "https://twitter.com/codewithmukesh" +[[main]] + name = "Docs" + url = "/docs/prologue/introduction/" weight = 10 +# [[main]] +# name = "Blog" +# url = "/blog/" +# weight = 20 + [[social]] name = "GitHub" pre = "" - url = "https://github.com/fullstackhero/" + url = "https://github.com/h-enk/doks" post = "v0.1.0" + weight = 10 + +[[social]] + name = "Twitter" + pre = "" + url = "https://twitter.com/getdoks" weight = 20 # [[footer]] diff --git a/config/_default/params.toml b/config/_default/params.toml index dbf18718..c7f1a73a 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -2,17 +2,20 @@ ## Homepage title = "fullstackhero" +titleSeparator = "-" +titleAddition = "Open-Source Framework for Modern Web Applications." +description = "fullstackhero is an ambitious project to cater the needs of Developers and Organizations and helps reduce the development hours by over 200+ hours!" logo = "/images/full-stack-hero-logo.png" navBarLogo = "/images/navbar-logo.png" -titleSeparator = "-" -titleAddition = "Open-Source Boilerplates for Modern Web Applications" -description = "fullstackhero is a collection of Enterprise Level Boilerplates for Modern Web Applications that gets you started with premium application development in no-time!" + +## Documentation +# docsVersion = "1" # Search -mainSections = ["dotnet-webapi-boilerplate","blog","contact"] +mainSections = ["blog", "blazor-webassembly-boilerplate", "dotnet-webapi-boilerplate", "basics"] ## Open Graph -images = ["doks.png"] +images = ["fullstackhero.png"] ogLocale = "en_US" domainTLD = "doks.netlify.app" titleHome = "Doks Theme" @@ -30,10 +33,10 @@ schemaAuthorTwitter = "https://twitter.com/iammukeshm" schemaAuthorLinkedIn = "https://www.linkedin.com/in/iammukeshm/" schemaAuthorGitHub = "https://github.com/iammukeshm" schemaLocale = "en-US" -schemaLogo = "logo-doks.png" +schemaLogo = "logo-fullstackhero.png" schemaLogoWidth = 512 schemaLogoHeight = 512 -schemaImage = "doks.png" +schemaImage = "fullstackhero.png" schemaImageWidth = 1280 schemaImageHeight = 640 schemaTwitter = "https://twitter.com/codewithmukesh" @@ -42,29 +45,36 @@ schemaGitHub = "https://github.com/fullstackhero" schemaSection = "blog" ## Sitelinks Search Box -siteLinksSearchBox = true +siteLinksSearchBox = false ## Chrome Browser themeColor = "#fff" # Images -quality = 85 +quality = 100 bgColor = "#fff" -landscapePhotoWidths = [900, 800, 700, 600, 500] -portraitPhotoWidths = [800, 700, 600, 500] +landscapePhotoWidths = [2000, 1000, 900, 800, 700, 600, 500,400] +portraitPhotoWidths = [800, 700, 600, 500,100] lqipWidth = "20x" +smallLimit = "30" # Footer footer = "Developed & Maintained by Mukesh Murugan" -copyRight = "Copyright (c) 2020-2021 Mukesh Murugan" + +# Feed +copyRight = "Copyright (c) 2021-2022 Mukesh Murugan" # Alert alert = true -alertText = "Support the project by buying me a coffee!" +alertDismissable = false +alertText = ".NET 7 WebAPI Boilerplate Released 🚀😁 Click here to get started! 😎☕" # Edit Page +repoHost = "GitHub" docsRepo = "https://github.com/fullstackhero/docs" +docsRepoBranch = "master" editPage = true +lastMod = true [options] lazySizes = true @@ -72,7 +82,15 @@ editPage = true instantPage = true flexSearch = true darkMode = true - bootStrapJs = false + bootStrapJs = true breadCrumb = true highLight = true - kaTex = true + kaTex = false + multilingualMode = false + docsVersioning = false + fullWidth = true + +[menu] + [menu.section] + auto = false + collapsibleSidebar = false diff --git a/config/next/config.toml b/config/next/config.toml index bf4bbcd9..9c5e90da 100644 --- a/config/next/config.toml +++ b/config/next/config.toml @@ -1,2 +1 @@ -baseurl = "https://doks-next.netlify.app/" -canonifyURLs = true +canonifyURLs = false diff --git a/config/postcss.config.js b/config/postcss.config.js index d5edc254..f9d1a18a 100644 --- a/config/postcss.config.js +++ b/config/postcss.config.js @@ -20,13 +20,17 @@ module.exports = { 'td', 'h5', 'alert-link', + 'container-xxl', + 'container-fluid', ...whitelister([ + './assets/scss/components/_alerts.scss', './assets/scss/components/_buttons.scss', './assets/scss/components/_code.scss', './assets/scss/components/_diagrams.scss', './assets/scss/components/_syntax.scss', './assets/scss/components/_search.scss', './assets/scss/common/_dark.scss', + './node_modules/bootstrap/scss/_dropdown.scss', './node_modules/katex/dist/katex.css', ]), ], diff --git a/config/production/config.toml b/config/production/config.toml index e58d95ef..9c5e90da 100644 --- a/config/production/config.toml +++ b/config/production/config.toml @@ -1,2 +1 @@ -baseurl = "https://fullstackhero.net/" -canonifyURLs = true +canonifyURLs = false diff --git a/content/blog/say-hello-to-doks/index.md b/content/blog/say-hello-to-doks/index.md deleted file mode 100644 index a3a233ec..00000000 --- a/content/blog/say-hello-to-doks/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Say hello to fullstackhero 👋" -description: ".NET WebAPI Boilerplate Template built with .NET 6.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." -lead: ".NET WebAPI Boilerplate Template built with .NET 6.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." -date: 2020-11-04T09:19:42+01:00 -lastmod: 2021-09-10T06:07:15+05:30 -draft: false -weight: 50 -contributors: ["Mukesh Murugan"] ---- diff --git a/content/blog/say-hello-to-doks/say-hello-to-doks.png b/content/blog/say-hello-to-doks/say-hello-to-doks.png deleted file mode 100644 index 860ad414..00000000 Binary files a/content/blog/say-hello-to-doks/say-hello-to-doks.png and /dev/null differ diff --git a/content/dotnet-webapi-boilerplate/_index.md b/content/dotnet-webapi-boilerplate/_index.md deleted file mode 100644 index 1bd4ba90..00000000 --- a/content/dotnet-webapi-boilerplate/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title : ".NET WebAPI Boilerplate" -description: "Essential Documentation for the .NET WebAPI Boilerplate project." -lead: "" -date: 2021-08-24T11:40:05+05:30 -lastmod: 2021-11-23T01:58:00+05:30 -draft: false -images: [] ---- -{{< img src="fullstackhero-dotnet-webapi-banner.jpg" >}} diff --git a/content/dotnet-webapi-boilerplate/fullstackhero-dotnet-webapi-banner.jpg b/content/dotnet-webapi-boilerplate/fullstackhero-dotnet-webapi-banner.jpg deleted file mode 100644 index f2988a30..00000000 Binary files a/content/dotnet-webapi-boilerplate/fullstackhero-dotnet-webapi-banner.jpg and /dev/null differ diff --git a/content/dotnet-webapi-boilerplate/general/cli-commands.md b/content/dotnet-webapi-boilerplate/general/cli-commands.md deleted file mode 100644 index 3426052a..00000000 --- a/content/dotnet-webapi-boilerplate/general/cli-commands.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "CLI Commands" -description: "Here are some important CLI Commands that are to be used along with fullstackhero." -lead: "Here are some important CLI Commands that are to be used along with fullstackhero." -date: 2021-08-24T11:40:05+05:30 -lastmod: 2021-10-28T10:07:45+05:30 -draft: false -images: [] -menu: - webapi: - identifier: "cli-commands" - name: "CLI Commands" - parent: "general" -weight: 4 -toc: true ---- - - -## Docker - -### Build - -This command is to be executed from the root folder of the project. - -```powershell -docker build -t iammukeshm/dotnet-webapi:0.0.3-rc -t iammukeshm/dotnet-webapi:latest . -``` -### Push to DockerHub - -This command is to be executed from the root folder of the project. - -```powershell -docker push iammukeshm/dotnet-webapi -``` - -## Migrations -This command is to be executed from the Bootstrapper Directory of the project. - -```powershell -dotnet ef migrations add --project .././Migrators/Migrators./ --context ApplicationDbContext -o Migrations/Application -``` -CommitMessage : Enter a commit message here. -Provider : Enter the available DB Provider name. MSSQL , MySQL , PostgreSQL - -## NuGet - -Generates a NuGet Package of the entire solution. NuGet Configuration is available in the *.nuspec file at the root of the project directory. This command is to be executed from the Root Directory of the project. - -```powershell -nuget pack -NoDefaultExcludes -``` diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/folder-structure.jpg b/content/dotnet-webapi-boilerplate/general/getting-started/folder-structure.jpg deleted file mode 100644 index 0b32232d..00000000 Binary files a/content/dotnet-webapi-boilerplate/general/getting-started/folder-structure.jpg and /dev/null differ diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/generate-solution.jpg b/content/dotnet-webapi-boilerplate/general/getting-started/generate-solution.jpg deleted file mode 100644 index b12e5cba..00000000 Binary files a/content/dotnet-webapi-boilerplate/general/getting-started/generate-solution.jpg and /dev/null differ diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/index.md b/content/dotnet-webapi-boilerplate/general/getting-started/index.md deleted file mode 100644 index 1e1596fb..00000000 --- a/content/dotnet-webapi-boilerplate/general/getting-started/index.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -title: "Getting Started" -description: "Let's get started with the .NET WebApi Boilerplate!" -lead: "Let's get started with the .NET WebApi Boilerplate!" -date: 2021-08-30T00:59:34+05:30 -lastmod: 2021-11-23T01:55:29+05:30 -draft: false -images: [] -menu: - webapi: - identifier: "general-getting-started" - name: "Getting Started" - parent: "general" -weight: 3 -toc: true ---- -To start using fullstackhero .NET WebAPI Boilerplate, there are a couple of options. - -But before that, make sure that you have already setup your development environment that runs the prerequisite tools and SDKs. Refer [Development Environment](/dotnet-webapi-boilerplate/general/development-environment/) for details. - -This guide will take you right from installing the `fullstackhero .NET WebAPI Boilerplate` package to testing the API using the provided Postman Collection! - -## Installing NuGet Package - -This is by far the easiest and the most streamlined way of getting the latest available release version of fullstackhero .NET WebApi Boilerplate. - -Open up your Command Prompt / Powershell and run the following command to install the solution template. - -```powershell -dotnet new --install FullStackHero.WebAPI.Boilerplate::0.0.4-rc -``` - -{{< img src="install-fullstackhero.jpg" >}} - -This would install the `fullstackhero .NET WebAPI Boilerplate` template globally on your machine. Do note that, at the time of writing this documentation, the latest available version is **0.0.4-rc** which is also one of the first pre-release version of the package. It is highly likely that there is already a newer version available when you are reading this. - -*To get the latest version of the package, visit [nuget.org](https://www.nuget.org/packages/FullStackHero.WebAPI.Boilerplate)* - -{{< alert text="FullStackHero.WebAPI.Boilerplate is now in pre-release state. You can find the latest version on NuGet.org" />}} - -## Creating your First Solution - -Now that you have installed the template locally on your machine, let's see how you can start generating complete .NET WebAPI Solutions seamlessly. - -Simply navigate to a new directory (wherever you want to place your new solution at), and open up Command Prompt at the opened directory. - -Run the following command. Note that, in this demonstration I am naming my new solution as `FSH.Starter`. - -```powershell -dotnet new fsh-api -o FSH.Starter -``` - -{{< img src="generate-solution.jpg" >}} - -Once that is done, your new solution is created for you. As simple as that! - -Here are the folders and files created for you. - -{{< img src="folder-structure.jpg" >}} - -## Alternatively.. - -When you installed the NuGet package, there is also an entry that has been created into your Visual Studio Template for fullstackhero's .NET WebAPI Boilerplate. If you find it easier to work with Visual Studio rather than CLI Commands to generate new solutions, you are free to do so. - -Simply open up Visual Studio 2022 and Click on Create New Project. - -{{< img src="visual-studio-support.jpg" >}} - -Important - Make sure to check the 'Place solution and project in same directory' option. Else the solution and projects will be created on different folders and there will be build errors stating that few files are not found. - -{{< img src="vs-same-directory.jpg" >}} - -Another issue I noticed with creating solutions via Visual Studio is that the Solution structure might be lost. This is a very minor bug, that maybe someone can figure out and fix in our template configuration. Microsoft doesn't seem to have very detailed guide about this. - -However, it's always recommended to create new solutions via the Console. - -## Running the Application - -Next, open up command prompt on this directory and run the following. - -```powershell -code . -``` - -This opens up the solution via Visual Code. Make sure that you have the prerequisite tools and SDKs setup. - -### Setting up the Connection String -Next, let's set up some valid connection strings. Navigate to `src/Bootstrapper/Configurations` and open up `database.json`. Here you would have to provide a valid connection string under the `DatabaseSettings` to either MSSQL, MySQL or PostgreSQL instance. Below are some sample settings for each of the DB Providers. - -Details on the usage of other Settings will be explained in the upcoming documentations. - -#### MySQL - -```powershell -"DatabaseSettings": { - "ConnectionString": "server=localhost;uid=root;pwd=root;database=defaultRootDb;Allow User Variables=True", - "DBProvider": "mysql" - } -``` -#### MSSQL - -```powershell -"DatabaseSettings": { - "DBProvider": "mssql", - "ConnectionString": "Data Source=(localdb)\\mssqllocaldb;Initial Catalog=rootTenantDb;Integrated Security=True;MultipleActiveResultSets=True" - } -``` -#### PostgreSQL - -```powershell -"DatabaseSettings": { - "ConnectionString": "Host=localhost;Database=rootTenantDb;Username=postgres;Password=root;Include Error Detail=true", - "DBProvider": "postgresql" - } -``` - -Now you need to navigate to the `Bootstrapper (API) Project` directory via CMD or VSCode's native terminal and run the basic build and run command to get the API up and running. Run the following. - -```powershell - cd src/Bootstrapper - dotnet build - dotnet run -``` - -{{< img src="running-api.jpg" >}} - -As you can see from the logs, a couple of operations happen as soon as you launch the application. Let me give a brief idea on what happens when you run the application for the very first time. - -- The Migrations that already come out-of-the-box with the application gets applied. Note that you do not have to update the database. -- The Application is programmed to seed a default Tenant named `root`, that is basically the super-admin of the entire application and has permissions to manage tenants. -- Once Tenant record is seeded, the tenant admin , roles and permissions are also seeded. Note that the default credentials for the root tenant admin is as follows. - -```powershell -{ - "email":"admin@root.com", - "password":"123Pa$$word!" -} -``` - -- The Connection String that you provided in the appSettings will be taken as the `root` Tenant's Connection. Note that all the tenant data will be stored on to this connection under the Tenants table. - -## Testing the Postman Collection - -Now that our application is up and running, let's fire up POSTMAN and run some basic requests. You can find the updated Postman collection under the /postman folder of your solution. Import this postman collection on to your local Postman. - -Note that I have set up some default collection variables to make things easier. - -{{< img src="postman-collection.jpg" >}} - -In case your application happens to start on a different Port, you would have to change the `url` variable on this collection and save it. - -Let's start by generating a token for the `root admin` user! Navigate to the Identity/get-token request and simply run it. If everything goes as expected, you would be seeing a valid token as your response. - -{{< img src="token-response.jpg" >}} - -Whenever a valid token is generated via Postman, it is stored as a variable of the collection and is used by default for all the subsequent requests via Postman until the token expires. You can test that the token is valid by sending the 'get-brands' request. Presuming that you have a valid token you'll see: - -```powershell -{ - "data": [], - "currentPage": 1, - "totalPages": 0, - "totalCount": 0, - "pageSize": 2147483647, - "hasPreviousPage": false, - "hasNextPage": false, - "messages": [], - "succeeded": true -} -``` - -This indicates a successful response but the empty data value indicates that the db doesn't have any Brands yet. Time to fix that! - -## Adding Data - -Open the **create-brands** request in Postman and run it. Click the 'Body' tab to review the values we'll be sending. After sending you should see a something like: - -```powershell -{ - "data": "0f8e6d6e-d574-4d2f-b9ac-4dd1c9ffa0ae", - "messages": [], - "succeeded": true -} -``` - -Resend the **'search-brands'** request to see: - -```powershell -{ - "data": [ - { - "id": "2c87358e-0bfa-4d69-8d20-c2fd3b043e0f", - "name": "Brand #2", - "description": "Something Cool!" - } - ], - "currentPage": 1, - "totalPages": 1, - "totalCount": 1, - "pageSize": 2147483647, - "hasPreviousPage": false, - "hasNextPage": false, - "messages": [], - "succeeded": true -} -``` - -Next let's add a product. Run the **'create-product'** request at this point and you'll see a failure message: - -```powershell -{ - "source": "DN.WebApi.Application", - "exception": "brand.notfound [en-US]", - "errorCode": 404, - "succeeded": false -} -``` - -What went wrong?? Click the '**Body**' tab and look at the value for the _brandId_. That field needs to match the _ID_ value of the **Brands** table. When I created the Postman collection I had to use the values that existed while I was building the project from my workstation. If you revisit the '**search-brands**' request and look at the results you'll see a value for '_id_'. Copy that value - return to the `**create-product**' request - replace the id value with what you'd copied and re-send the command. It should report success now. diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/postman-collection.jpg b/content/dotnet-webapi-boilerplate/general/getting-started/postman-collection.jpg deleted file mode 100644 index 7d2d9290..00000000 Binary files a/content/dotnet-webapi-boilerplate/general/getting-started/postman-collection.jpg and /dev/null differ diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/token-response.jpg b/content/dotnet-webapi-boilerplate/general/getting-started/token-response.jpg deleted file mode 100644 index 5396a2f9..00000000 Binary files a/content/dotnet-webapi-boilerplate/general/getting-started/token-response.jpg and /dev/null differ diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/visual-studio-support.jpg b/content/dotnet-webapi-boilerplate/general/getting-started/visual-studio-support.jpg deleted file mode 100644 index b31652cd..00000000 Binary files a/content/dotnet-webapi-boilerplate/general/getting-started/visual-studio-support.jpg and /dev/null differ diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/vs-same-directory.jpg b/content/dotnet-webapi-boilerplate/general/getting-started/vs-same-directory.jpg deleted file mode 100644 index 2b141d24..00000000 Binary files a/content/dotnet-webapi-boilerplate/general/getting-started/vs-same-directory.jpg and /dev/null differ diff --git a/content/dotnet-webapi-boilerplate/general/overview.md b/content/dotnet-webapi-boilerplate/general/overview.md deleted file mode 100644 index 4adf0a43..00000000 --- a/content/dotnet-webapi-boilerplate/general/overview.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: "Overview" -description: ".NET WebAPI Boilerplate Template built with .NET 6.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." -lead: ".NET WebAPI Boilerplate Template built with .NET 6.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." -date: 2021-08-24T11:40:05+05:30 -lastmod: 2021-10-26T08:03:38+05:30 -draft: false -images: [] -menu: - webapi: - identifier: "general-overview" - name: "Overview" - parent: "general" -weight: 1 -toc: true ---- - -## About - -`dotnet-webapi-boilerplate` is the integral part of the `fullstackhero` project. - -`fullstackhero` is a venture to develop industry leading boilerplate templates for the dotnet stack as the backend (Web API) along with modern client frameworks like Angular, MVC and Blazor. - -This repository contains the WebApi Project of `fullstackhero`. - -## Release Planning - -### 0.0.3 RC is available now! - -- Migration Refresh -- Security Patches -- Image Upload Fix -- Option to Disable Swagger -- Cleaner Code -- Activate / Deactivate Tenants -- Upgrade Tenant Subscription -- Advanced Search - -This is the first pre-release version of the `fullstackhero .NET WebAPI Boilerplate` package. Newer versions will be available on a weekly basis with newer updates and patches. [Read the getting-started guide for more.](https://fullstackhero.net/dotnet-webapi-boilerplate/general/getting-started/) - -The Release Version is expected to be out by November 2021 as soon as .NET 6 LTS is launched by Microsoft. Preview versions of this project are available for Initial Developer Testing. - -## Quick Start Guide - -Open up your Command Prompt / Powershell and run the following command to install the solution template. - -```powershell -dotnet new --install FullStackHero.WebAPI.Boilerplate -``` -This would install the `fullstackhero .NET WebAPI Boilerplate` template globally on your machine. With that done, let's see how you can start generating complete .NET WebAPI Solutions seamlessly. - -Simply navigate to a new directory (wherever you want to place your new solution), and open up Command Prompt at the opened directory. - -Run the following command. Note that, in this demonstration, I am naming my new solution as `FSH.Starter`. - -```powershell -dotnet new fsh-api -o FSH.Starter -``` - -For further steps and details, [Read the Getting Started Guide](https://fullstackhero.net/dotnet-webapi-boilerplate/general/getting-started/) - -## Important Links & Documentations - -Overview - [Read](https://fullstackhero.net/dotnet-webapi-boilerplate/general/overview/) - -Getting Started - [Read](https://fullstackhero.net/dotnet-webapi-boilerplate/general/getting-started/) - -Development Environment - [Learn about setting up the DEV environment](https://fullstackhero.net/dotnet-webapi-boilerplate/general/development-environment/) - -Track Progress - [Release 1.0 Milestones](https://github.com/fullstackhero/dotnet-webapi-boilerplate/milestone/1) - -Participate in Discussions - [QNA & General Discussions](https://github.com/fullstackhero/dotnet-webapi-boilerplate/discussions) - -Join our Discord - [fullstackhero @ Discord](https://discord.gg/gdgHRt4mMw) - -## Features - -- [x] Built on .NET 6.0 -- [x] Follows Clean Architecture Principles -- [ ] Completely Documented at [fullstackhero.net](https://fullstackhero.net) -- [x] Multi Tenancy Support - - [x] Create Tenants with Multi Database / Shared Database Support - - [x] Activate / Deactivate Tenants on Demand - - [x] Upgrade Subscription of Tenants - Add More Validity Months to each tenant! -- [x] Supports MySQL, MSSQL & PostgreSQL! -- [x] Uses Entity Framework Core as DB Abstraction -- [x] Flexible Repository Pattern -- [x] Dapper Integration for Optimal Performance -- [x] Serilog Integration -- [x] Swagger Support -- [x] Mapster Integration for Quicker Mapping -- [x] API Versioning -- [x] Response Caching - Distributed Caching -- [x] Fluent Validations -- [x] Audit Logging -- [ ] Advanced User & Role Based Permission Management -- [x] Code Analysis & StyleCop Integration with Rulesets -- [x] JSON Based Localization with Caching -- [x] Hangfire Support -- [x] File Storage Service -- [ ] Test Projects -- [ ] & Much More - -## Community - -- Discord [@fullstackhero](https://discord.gg/gdgHRt4mMw) - -## License - -This project is licensed with the [MIT license](LICENSE). - -## Support :star: - -Has this Project helped you learn something New? or Helped you at work? -Here are a few ways by which you can support. - -- Leave a star! :star: -- Recommend this awesome project to your colleagues. đŸĨ‡ -- Do consider endorsing me on LinkedIn for ASP.NET Core - [Connect via LinkedIn](https://codewithmukesh.com/linkedin) đŸĻ¸ -- Or, If you want to support this project in the long run, [consider buying me a coffee](https://www.buymeacoffee.com/codewithmukesh)! ☕ - - Buy me - a Coffee diff --git a/content/dotnet-webapi-boilerplate/general/project-structure/index.md b/content/dotnet-webapi-boilerplate/general/project-structure/index.md deleted file mode 100644 index b5a5f0bd..00000000 --- a/content/dotnet-webapi-boilerplate/general/project-structure/index.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "Project Structure" -description: "Here is how the .NET WebApi Boilerplate is structured." -lead: "Here is how the .NET WebApi Boilerplate is structured." -date: 2021-08-24T11:40:05+05:30 -lastmod: 2021-11-06T13:29:23+05:30 -draft: false -images: [] -menu: - webapi: - identifier: "general-project-structure" - name: "Project Structure" - parent: "general" -weight: 5 -toc: true ---- - -fullstackhero's .NET WebApi Boilerplate is based on Clean Architecture. In other words, Onion / Hexagonal Architecture. [Read about the advantages and principles of Onion Architecture here →]("https://codewithmukesh.com/blog/onion-architecture-in-aspnet-core/") - -## General Structure - -This means that the entire solution is built in such a way that it can be scaled, maintained easily by teams of developers. This WebAPI Solution Primarily consists of the following .csproj files. - -```bash -├── src -│ ├── Bootstrapper.csproj -│ ├── Core -│ | ├── Application.csproj -│ | └── Domain.csproj -| ├── Infrastructure.csproj -| ├── Migrators -│ | ├── Migrators.MSSQL.csproj -│ | ├── Migrators.MySQL.csproj -│ | └── Migrators.PostgreSQL.csproj -│ └── Shared -│ └── Shared.DTOs.csproj -``` - -The idea is to build a very loosely coupled architecture following best practices and packages. Let's see in brief what responsibilities each of these projects handle. - -### Bootstrapper -Contains the API Controllers and Startup Logic including ASP.NET Core Container setup. This is the entry point of the application. Also, other static files like the logs, localization jsons, images, email templates and most importantly the appsettings.json live under this project. - -```bash -├── Bootstrapper -| ├── Controllers -| ├── Email Templates -| ├── Files -│ | ├── Images -│ | └── Documents -| ├── Localization -| ├── Settings -| └── appsettings.json -``` - -Note that the *Bootstrapper* project depends on -- Application -- Infrastructure -- Migration Projects - -### Application - -This is one of the projects in the Core Folder apart from the Domain Project. Here you get to see Abstract Classes and Interfaces that are inherited and implemented in the Infrastructure Project. This refers to Dependency Inversion. - -``` bash -├── Core -| ├── Application -| | ├── Abstraction -| | ├── Constants -| | ├── Exceptions -| | ├── Extensions -| | ├── Services -| | ├── Settings -| | ├── Specifications -| | ├── Validators -| | └── Wrapper - -``` - -1. Abstraction folder consists of the majorly used Interfaces throughout the project including **IRepositoryAsync** and **ITenantService** - -Note that the *Application* project does not depend on any other project. - -### Domain - -Note that the *Domain* project does not depend on any other project. - - -As per Clean Architecture principles, the Core of this Solution i.e, Application and Domain projects do not depend on any other projects. This helps achieve Dependency Inversion (The 'D' Principle of 'SOLID'). - -## Directory - -This is the folder directory you will be seeing every-time a new project is generated via the FullStackHero .NET WebAPI Template. -```bash -├── src -│ ├── Bootstrapper -│ | ├── Controllers -│ | ├── Email Templates -│ | ├── Files -│ | ├── Localization -│ | ├── Settings -│ | └── appsettings.json -| ├── Core -│ | ├── Application -│ | | ├── Abstraction -│ | | ├── Constants -│ | | ├── Exceptions -│ | | ├── Extensions -│ | | ├── Services -│ | | ├── Settings -│ | | ├── Specifications -│ | | ├── Validators -│ | | └── Wrapper -│ | └── Domain -│ | | ├── Constants -│ | | ├── Contracts -│ | | ├── Entities -│ | | ├── Enums -│ | | ├── Events -│ | | ├── Extensions -│ | | └── Interfaces -| ├── Infrastructure -│ | ├── Auditing -│ | ├── Extensions -│ | ├── HealthChecks -│ | ├── Identity -│ | ├── Localizer -│ | ├── Mappings -│ | ├── Middlewares -│ | ├── Persistence -│ | ├── Services -│ | ├── SwaggerFilters -│ | └── Utilities -| ├── Migrators -│ | ├── Migrators.MSSQL -│ | ├── Migrators.MySQL -│ | └── Migrators.PostgreSQL -│ └── Shared -│ └── Shared.DTOs -├── postman -├── deployments -├── tests -├── README.md -├── DN.WebAPI.sln -├── LICENSE -└── .gitignore -``` diff --git a/content/en/_index.md b/content/en/_index.md new file mode 100644 index 00000000..c6b36df2 --- /dev/null +++ b/content/en/_index.md @@ -0,0 +1,10 @@ +--- +title : "fullstackhero" +description: "fullstackhero offers Boilerplates with latest packages and services that your projects will ever need. We intend to provide Clean and Well structured Boilerplates with top-notch quality following standard coding practices and Clean Architecture principles that makes your development experience seemless." +lead: "fullstackhero offers Boilerplates with latest packages and services that your projects will ever need. We intend to provide Clean and Well structured Boilerplates with top-notch quality following standard coding practices and Clean Architecture principles that makes your development experience seemless." +sub: "Open-Source Framework for Modern Web Applications." +date: 2020-10-06T08:47:36+00:00 +lastmod: 2022-02-06T00:53:13+05:30 +draft: false +images: [] +--- diff --git a/content/_index.md b/content/en/basics/_index.md similarity index 64% rename from content/_index.md rename to content/en/basics/_index.md index c70e210d..8496a8b3 100644 --- a/content/_index.md +++ b/content/en/basics/_index.md @@ -1,9 +1,11 @@ --- -title : "fullstackhero" +title : "Basics" description: "fullstackhero is a collection of Enterprise Level Boilerplates for Modern Web Applications that gets you started with premium application development in no-time!" -lead: "Open-Source Boilerplates for Modern Web Applications - Simplified" +lead: "" date: 2021-08-24T11:40:05+05:30 -lastmod: 2021-08-24T12:07:11+05:30 +lastmod: 2021-08-24T12:44:46+05:30 draft: false images: [] --- + +{{< img src="fullstackhero.png" >}} diff --git a/content/en/basics/contributing/index.md b/content/en/basics/contributing/index.md new file mode 100644 index 00000000..20c90a50 --- /dev/null +++ b/content/en/basics/contributing/index.md @@ -0,0 +1,57 @@ +--- +title: "Contributing" +description: "Let's get started with fullstackhero!" +lead: "Let's get started with fullstackhero!" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2021-12-12T08:03:50+05:30 +draft: false +images: [] +menu: + basics: + identifier: "basics-contributing" + name: "Contributing" + parent: "basics" +weight: 3 +toc: true +--- + +Being a completely community driven project, I encourage the community to submit their valuable contributions to whichever repository they are comfortable with. + +Currently, you can contribute to - + +- fullstackhero Documentation - https://github.com/fullstackhero/docs +- .NET Web API Boilerplate - https://github.com/fullstackhero/dotnet-webapi-boilerplate +- Blazor WebAssembly Boilerplate - https://github.com/fullstackhero/blazor-wasm-boilerplate + +## Docs + +### How to contribute? + +Please note the following steps are applicable only for the `docs` repository. + +1. Fork the `docs` Repository to your Github Profile. +2. `[Optional]` Navigate to your newly forked Repository -> Settings -> Secrets. +3. `[Optional]` Here, Add a new Repository Secret with a name `GT_TOKEN`. As for the value, paste in your GitHub Token (https://github.com/settings/tokens) +4. Now, clone this repository locally. +5. Ensure that you have Node.js and Visual Code installed. +6. At the root of the repository run `npm install`. This installs all the required packages. Might take some time depending on your network connection. +7. All the documentations are to be written in markdown format. +8. Refer https://github.com/fullstackhero/docs/blob/main/content/en/dotnet-webapi-boilerplate/general/getting-started/index.md to get an idea on how to write documentation and include images, code snippets and stuff. +9. To run the application locally, run the command `npm run start` and navigate to localhost:1313 +10. Once ready, send a Pull Request. + +## Blazor WebAssembly Boilerplate + +Here are the contributors of the Blazor WASM Project! Submit your PR to join this Elite list ;) Make sure your code is warning free! + + + + + +## .NET Web API Boilerplate + +Submit your PR and join the elite list! + + + + diff --git a/content/en/basics/exploring-docs/docs.png b/content/en/basics/exploring-docs/docs.png new file mode 100644 index 00000000..d167ed63 Binary files /dev/null and b/content/en/basics/exploring-docs/docs.png differ diff --git a/content/en/basics/exploring-docs/index.md b/content/en/basics/exploring-docs/index.md new file mode 100644 index 00000000..b2013f4f --- /dev/null +++ b/content/en/basics/exploring-docs/index.md @@ -0,0 +1,20 @@ +--- +title: "Exploring Docs" +description: "Exploring fullstackhero Docs!" +lead: "Exploring fullstackhero Docs!" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2021-12-12T08:03:50+05:30 +draft: false +images: [] +menu: + basics: + identifier: "basics-exploring-docs" + name: "Exploring Docs" + parent: "basics" +weight: 2 +toc: true +--- + +fullstackhero sports a pretty much straight forward documentation website that is frequently updated and also accepts new documentations / corrections from the community! + +{{< img src="docs.png" >}} diff --git a/content/en/basics/fullstackhero.png b/content/en/basics/fullstackhero.png new file mode 100644 index 00000000..845b4345 Binary files /dev/null and b/content/en/basics/fullstackhero.png differ diff --git a/content/en/basics/getting-started/fullstackhero.png b/content/en/basics/getting-started/fullstackhero.png new file mode 100644 index 00000000..845b4345 Binary files /dev/null and b/content/en/basics/getting-started/fullstackhero.png differ diff --git a/content/en/basics/getting-started/index.md b/content/en/basics/getting-started/index.md new file mode 100644 index 00000000..b2ad8e9a --- /dev/null +++ b/content/en/basics/getting-started/index.md @@ -0,0 +1,96 @@ +--- +title: "Getting Started 🚀" +description: "Let's get started with fullstackhero!" +lead: "Let's get started with fullstackhero!" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2021-12-12T08:03:50+05:30 +draft: false +images: [] +menu: + basics: + identifier: "basics-getting-started" + name: "Getting Started 🚀" + parent: "basics" +weight: 1 +toc: true +--- +
+ +{{< img src="fullstackhero.png" >}} + +## Problem Statement + +

Ever gone through the pain of setting up new Projects from scratch each and every time? fullstackhero aims to +address this pain point by offering Starting Points aka Boilerplates for various technologies that can help save +over 200+ hours of Development and Research Time for Developers and Teams.

+ +## Solution + +

fullstackhero offers Boilerplates with latest packages and services that your projects will ever need. We intend to provide Clean and Well structured Boilerplates with top-notch quality following standard coding practices and Clean Architecture principles that makes your development experience seamless. +

+

Most importantly, fullstackhero is completely FREE to use!

+ +As the name suggests, the idea is to provide a full-stack end to end solution to kick start products of any scale following a modularized monolith architecture with well cut designs, code readability, scalability as the out-of-the-box features. Bottomline, using fullstackhero, your new projects will be up and running in no time. + + +## Vision + +fullstackhero is not a single repository or project, rather a collection of boilerplates out of which you get to choose your preference. In the long term, fullstackhero would ideally have multiple API projects that are written in various technologies like .NET, Node.js, GoLang and multiple client applications that are built on awesome tech like Blazor, Vue.js, React, Angular and so on. + +fullstackhero should be the one-stop that caters to the needs of various developers in various technology. This obviously would require a lot of community adaptation and contributions. + +As of the initial releases, fullstackhero sports an API Project built on Microsoft's newest .NET 7 and the front-end application (that consumes the .NET 7 Web API) built with Blazor WebAssembly! + +## Projects + +

Here are the awesome fullstackhero projects!

+
+
+
+
+
+

.NET 7 Microservices Boilerplate

+
+
server
+
dotnet
+
microservices
+
+

Coming soon.

+

View Github Repository | Read Getting Started Guide

+
+
+
+
+

.NET 7 Web API Boilerplate

+
+
server
+
dotnet
+
multitenancy
+
+

Get to work with the latest and greatest of Microsoft's .NET 7 Web API fused with the goodness of fullstackhero.

+

View Github Repository | Read Getting Started Guide

+
+
+
+
+

Blazor WebAssembly Boilerplate

+
+
client application
+
dotnet
+
blazor webassembly
+
multitenancy
+
+

Clean Architecture Boilerplate Template for .NET 6.0 Blazor WebAssembly built for FSH WebAPI with the goodness of MudBlazor Components.

+

View Github Repository | Read Getting Started Guide

+
+
+
+

Angular Material Boilerplate

+

Coming Soon!

+
+
+

ASP.NET MVC Boilerplate

+

Coming Soon!

+
+
+
diff --git a/content/en/blazor-webassembly-boilerplate/_index.md b/content/en/blazor-webassembly-boilerplate/_index.md new file mode 100644 index 00000000..85a33c07 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/_index.md @@ -0,0 +1,9 @@ +--- +title : "Blazor WebAssembly Boilerplate" +description: "Essential Documentation for the Blazor WebAssembly Boilerplate project." +lead: "" +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-23T01:58:00+05:30 +draft: false +images: [] +--- diff --git a/content/en/blazor-webassembly-boilerplate/fullstackhero-blazor-wasm-banner.png b/content/en/blazor-webassembly-boilerplate/fullstackhero-blazor-wasm-banner.png new file mode 100644 index 00000000..d2f24b98 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/fullstackhero-blazor-wasm-banner.png differ diff --git a/content/en/blazor-webassembly-boilerplate/general/_index.md b/content/en/blazor-webassembly-boilerplate/general/_index.md new file mode 100644 index 00000000..21a9fca0 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/general/_index.md @@ -0,0 +1,9 @@ +--- +title : "General" +description: "fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-23T02:00:55+05:30 +lead: "" +draft: false +images: [] +--- diff --git a/content/en/blazor-webassembly-boilerplate/general/development-environment.md b/content/en/blazor-webassembly-boilerplate/general/development-environment.md new file mode 100644 index 00000000..7ccad7f6 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/general/development-environment.md @@ -0,0 +1,44 @@ +--- +title: "Development Environment" +description: "Setting up the Development Environment for the Blazor WebAssembly Boilerplate" +lead: "Let's get started with setting up the Development Environment for Blazor WebAssembly Boilerplate Development!" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2021-10-15T08:54:03+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "general-development-environment" + name: "Development Environment" + parent: "general" +weight: 2 +toc: true +--- +fullstackhero's **Blazor WebAssembly Boilerplate** Project Development needs you to have the following applications / tools available on your machine. Please Note that this project is being built on a Windows 10 Machine using Visual Studio Code IDE. + +## .NET SDK + +As mentioned earlier, this project is built with the latest available .NET SDK, which is .NET 6.0. + +Ensure that you have the latest version of the SDK available - [Download from Microsoft](https://dotnet.microsoft.com/download/dotnet/6.0) + +{{< alert icon="💡" text="Note : At the time of compiling this documentation, the latest version available was SDK 6.0.200" />}} + + +## IDE + +Visual Studio Code IDE is the recommended IDE to use for fullstackhero's Blazor WebAssembly Boilerplate Project Development. If you are not already using this IDE, consider switching to it. It's definitely worth it! (_Fun Fact : I recently switched from Visual Studio 2019 Community to Visual Studio Code and it's been awesome!_) + +However, you are always free to use your choice of IDEs as well. + +Incase you intend to use Visual Studio Code for development, here are a bunch of helpful extensions that I use: +- EditorConfig for VS Code +- C# +- C# Extensions +- Docker +- Markdown All in One +- NuGet Gallery +- Material Icon Theme +- REST Client + +{{< alert icon="💡" text="Note : All the screenshots included in these documentations are from Visual Studio Code Point of View." />}} diff --git a/content/en/blazor-webassembly-boilerplate/general/getting-started/index.md b/content/en/blazor-webassembly-boilerplate/general/getting-started/index.md new file mode 100644 index 00000000..5f8c9cce --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/general/getting-started/index.md @@ -0,0 +1,100 @@ +--- +title: "Getting Started 🚀" +description: "Getting Started with fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Getting Started with fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "general-getting-started" + name: "Getting Started 🚀" + parent: "general" +weight: 3 +toc: true +--- + +Firstly, make sure that you have already setup your development environment that runs the prerequisite tools and SDKs. Refer [Development Environment](/blazor-webassembly-boilerplate/general/development-environment/) for details. + + +To get started with this Boilerplate, here are the avaiable options. + +- Fork the Repository. Use this if you want to always keep your version of the Boilerplate up-to date with the latest changes. +- Install using dotnet new . Use this for release versions of the Boilerplate only. Note that this option is currently unavailable for Blazor WASM Boilerplate. + +## Forking the Repository + +You would probably need to take this approach if you want to keep your source code upto date with the latest changes. To get started based on this repository, you need to get a copy locally. You have three options: fork, clone, or download. + +- Make a fork of fullstackhero's `blazor-wasm-boilerplate` repository in your Github account. +- Next, since you need to start your private personal project, create your new `blazor-wasm-boilerplate` personal project by cloning the forked repository on your personal github. This could be done as simple as running `git clone https://github.com/{yourgithubuseraccount}/blazor-wasm-boilerplate.git` locally on your development machine. +- Setup an upstream remote on your personal project pointing to your forked repository using command `git remote add upstream https://github.com/{yourgithubuseraccount}/blazor-wasm-boilerplate` and `git remote set-url --push upstream DISABLE` + +Now, whenever there is a new update on fullstackhero's `blazor-wasm-boilerplate` repository, you could simply pull in the latest change on your private fork of the fullstackhero's `blazor-wasm-boilerplate` repository and later merge these changes with you personal projects. + +For step by step instructions, [follow this](https://discord.com/channels/878181478972928011/892573122186838046/933513103688224838) and [this](https://gist.github.com/0xjac/85097472043b697ab57ba1b1c7530274). + +## Installing NuGet Package + +This is by far the easiest and the most streamlined way of getting the latest available `Release version` of fullstackhero Blazor WebAssembly Boilerplate. + +Open up your Command Prompt / Powershell and run the following command to install the solution template. + +```powershell +dotnet new --install FullStackHero.BlazorWebAssembly.Boilerplate +``` +or, if you want to use a specific version of the boilerplate, use + +```powershell +dotnet new --install FullStackHero.BlazorWebAssembly.Boilerplate::0.0.1-rc +``` +This would install the `fullstackhero Blazor WebAssembly Boilerplate` template globally on your machine. Do note that, at the time of writing this documentation, the latest available version is **0.0.1-rc** which is also one of the first stable pre-release version of the package. It is highly likely that there is already a newer version available when you are reading this. + +> *To get the latest version of the package, visit [nuget.org](https://www.nuget.org/packages/FullStackHero.BlazorWebAssembly.Boilerplate/)* +> +> *FullStackHero.BlazorWebAssembly.Boilerplate is now in pre-release state. You can find the latest version on NuGet.org* + +{{< alert text="FullStackHero.BlazorWebAssembly.Boilerplate::0.0.1-rc is compatible only with FullStackHero.WebAPI.Boilerplate::0.0.6-rc and above." />}} + + + +Get the .NET WebApi Boilerplate by running the following command + +``` +dotnet new --install FullStackHero.WebAPI.Boilerplate::0.0.6-rc +``` + +### Creating your First Solution + +> Note that this is not valid only if you have installed the NuGet package of this Boilerplate. + +Now that you have installed the template locally on your machine, let's see how you can start generating Blazor Web Assembly Projects. + +Simply navigate to a new directory (wherever you want to place your new solution at), and open up Command Prompt at the opened directory. + +Run the following command. Note that, in this demonstration I am naming my new solution as `FSH.Blazor`. + +```powershell +dotnet new fsh-blazor -o FSH.Blazor +``` + +Once that is done, your new solution is created for you. As simple as that! + +## Running the Application + +Firstly, keep in mind that this is a client application that actually consumes data by sending HTTP Requests to the API Server. Thus, you need to make sure that the API is up and running. + +To learn about setting up the API Server, refer [Getting Started with fullstackhero's .NET Web API](/dotnet-webapi-boilerplate/general/getting-started/). + +Once the Server is up and running, like any other Blazor application, simply navigate to the Host folder under the source folder of the Blazor Project (`\src\Host`) and run the following standard commands. + +- `dotnet restore` +- `dotnet build` +- `dotnet run` + +Once the build process is complete, the application would be reachable by accessing `https://localhost:5002` on your browser. + +By default, the API Server is set to be running on port 5001 of your local machine. If for some port related reason, you have to run the API on another port or so, navigate to `src\Client\wwwroot\appsettings.json` of the Blazor Project and change the API Base URL Property and set the value to the port that's exposing the API. This is the default configuration `"ApiBaseUrl": "https://localhost:5001/"`. + +Similarly, the Blazor Project by default is set to run on port 5003 of your local machine. Incase you change this to something else, ensure that you have updated the cors.json configuration file on your API project. This makes sure that there is no CORS related issues while the Blazor project tries to access the API Endpoints. diff --git a/content/en/blazor-webassembly-boilerplate/general/overview.md b/content/en/blazor-webassembly-boilerplate/general/overview.md new file mode 100644 index 00000000..3dbebcd9 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/general/overview.md @@ -0,0 +1,59 @@ +--- +title: "Overview" +description: "Built with .NET 6.0 and the goodness of MudBlazor Component Library. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." +lead: "Built with .NET 6.0 and the goodness of MudBlazor Component Library. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2022-02-26T20:18:26+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "general-overview" + name: "Overview" + parent: "general" +weight: 1 +toc: true +--- + + +## Goals + +The goal of this repository is to help developers / companies kickstart their Web Application Development with a pre-built Blazor WebAssembly Boilerplate that includes several much needed components and features. + +> Note that this is a frontend / client application only! The backend for this application is available in a seperate repository. +> - Find fullstackhero's .NET 6 Web API Boilerplate here - https://github.com/fullstackhero/dotnet-webapi-boilerplate + +## Prerequisites + +- Make sure you have the API Running. Here is FSH Backend - https://github.com/fullstackhero/dotnet-webapi-boilerplate +- Once fullstackhero's .NET 6 Web API is up and running, run the Blazor WebAssembly Project to consume it's services. + +## Community + +- Discord [@fullstackhero](https://discord.gg/gdgHRt4mMw) +- Facebook Page [@codewithmukesh](https://facebook.com/codewithmukesh) +- Youtube Channel [@codewithmukesh](https://youtube.com/c/codewithmukesh) + +## Contributors + +Submit your PR and join the elite list! + + + + + +## License + +This project is licensed with the [MIT license](LICENSE). + +## Support :star: + +Has this Project helped you learn something New? or Helped you at work? +Here are a few ways by which you can support. + +- Leave a star! :star: +- Recommend this awesome project to your colleagues. đŸĨ‡ +- Do consider endorsing me on LinkedIn for ASP.NET Core - [Connect via LinkedIn](https://codewithmukesh.com/linkedin) đŸĻ¸ +- Or, If you want to support this project in the long run, [consider buying me a coffee](https://www.buymeacoffee.com/codewithmukesh)! ☕ + +
diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/_index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/_index.md new file mode 100644 index 00000000..44b8914c --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/_index.md @@ -0,0 +1,9 @@ +--- +title : "UI Overview" +description: "Sneak Peak of fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-23T02:00:55+05:30 +lead: "" +draft: false +images: [] +--- diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/account/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/account/index.md new file mode 100644 index 00000000..732d2dc7 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/account/index.md @@ -0,0 +1,18 @@ +--- +title: "Account" +description: "Account Page in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Account Page in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-account" + name: "Account" + parent: "ui-overview" +weight: 104 +toc: true +--- + + diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/forgot-password.png b/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/forgot-password.png new file mode 100644 index 00000000..b1e596b0 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/forgot-password.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/index.md new file mode 100644 index 00000000..188589dc --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/index.md @@ -0,0 +1,36 @@ +--- +title: "Authentication" +description: "Auth Related Pages / Components in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Auth Related Pages / Components in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-authentication" + name: "Authentication" + parent: "ui-overview" +weight: 101 +toc: true +--- + +## Login + +Here is what you would be welcomed with, the login page! You can auto-fill the default username / password & tenant by clicking on the `Fill Administrator Credentials` button. + +Anyways, here are the default login details for your reference. + +- email - `admin@root.com` +- password - `123Pa$$word!` +- tenant - `root` + +{{< alert text="Make sure that you use valid tenant values! By default, only root tenant is created for you." />}} + +{{< img src="login.png" >}} + +## Forgot Password + +In case, you happen to forget your password, the application has the functionailty to reset the password for you. + +{{< img src="forgot-password.png" >}} diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/login.png b/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/login.png new file mode 100644 index 00000000..348cc509 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/authentication/login.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/catalog-management/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/catalog-management/index.md new file mode 100644 index 00000000..c9d89ef1 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/catalog-management/index.md @@ -0,0 +1,18 @@ +--- +title: "Catalog Management" +description: "Catalog Management Pages in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Catalog Management Pages in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-catalog-management" + name: "Catalog Management" + parent: "ui-overview" +weight: 106 +toc: true +--- + + diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/dashboard/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/dashboard/index.md new file mode 100644 index 00000000..f8b10a92 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/dashboard/index.md @@ -0,0 +1,18 @@ +--- +title: "Dashboard" +description: "Dashboard in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Dashboard in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-dashboard" + name: "Dashboard" + parent: "ui-overview" +weight: 103 +toc: true +--- + + diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/dialogs/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/dialogs/index.md new file mode 100644 index 00000000..48bbc58d --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/dialogs/index.md @@ -0,0 +1,20 @@ +--- +title: "Dialogs" +description: "Exploring Dialogs fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Exploring Dialogs fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-dialogs" + name: "Dialogs" + parent: "ui-overview" +weight: 109 +toc: true +--- + +## LogOut + +## Confirmation diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/body.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/body.png new file mode 100644 index 00000000..433531b7 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/body.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/border-radius.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/border-radius.png new file mode 100644 index 00000000..e14fefc3 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/border-radius.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/color-code.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/color-code.png new file mode 100644 index 00000000..ea5eac49 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/color-code.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/colors.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/colors.png new file mode 100644 index 00000000..bc089a23 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/colors.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/dark-mode.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/dark-mode.png new file mode 100644 index 00000000..f7353dda Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/dark-mode.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/default-pallete.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/default-pallete.png new file mode 100644 index 00000000..2de5a5a1 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/default-pallete.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/index.md new file mode 100644 index 00000000..d83a294e --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/index.md @@ -0,0 +1,81 @@ +--- +title: "Fundamentals" +description: "Exploring fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Exploring fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-fundamentals" + name: "Fundamentals" + parent: "ui-overview" +weight: 100 +toc: true +--- + +Here are some of the general components, features and pages that you get to see in fullstackhero's Blazor WebAssembly Boilerplate. + +## Loading Screen + +The following is the dedault loading screen of the template. + +You can tweak around the appearance by modifying `\src\Client\wwwroot\index.html`. + +{{< img src="loading.png" >}} + +## Basic Layout + +By default, the boilerplate sports an ADMIN Dashboard template that is mostly used for Management of Entities. + +### Navigation Bar + +{{< img src="nav-bar.png" >}} + +### Side Menu + +{{< img src="nav-menu.png" >}} + +### Body + +{{< img src="body.png" >}} + +## Theme Manager + +fullstackhero's Blazor WebAssembly Boilerplate comes with a built-in theme manager that helps you customize various UI aspects right from primary colors to the radius of the containers with ease. You can view the Theme Manager component by clicking on the Paint Icon that you would see on every page of the boilerplate. + +Note that each of the configuration changes you make get stored to your browser's localstorage. + +{{< img src="theme-manager.png" >}} + +### Dark Mode + +Easily Switch to Dark / Light Mode with a toggle that you find on the theme manager! + +{{< img src="dark-mode.png" >}} + +### Colors + +Here you get to set the Primary and Secondary colors used by the Blazor Application and personalize the already rich UI Boilerplate. + +{{< img src="colors.png" >}} + +{{< img src="default-pallete.png" >}} + +Not finding the color that you need? You can easily add new colors to this pallete by changing some code! + +In the below screenshot you can find the default 12 colors defined in code. + +{{< img src="color-code.png" >}} + +### Border Radius + +The Adjustable Slider helps you manipulate the Borders of the UI components. + +{{< img src="border-radius.png" >}} + +### Table Customization + +{{< img src="table-customization.png" >}} + diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/loading.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/loading.png new file mode 100644 index 00000000..9207259c Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/loading.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/nav-bar.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/nav-bar.png new file mode 100644 index 00000000..71cd370f Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/nav-bar.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/nav-menu.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/nav-menu.png new file mode 100644 index 00000000..9d3e0ea9 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/nav-menu.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/table-customization.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/table-customization.png new file mode 100644 index 00000000..9de7daf6 Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/table-customization.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/theme-manager.png b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/theme-manager.png new file mode 100644 index 00000000..570fa13c Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/fundamentals/theme-manager.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/home/home.png b/content/en/blazor-webassembly-boilerplate/ui-overview/home/home.png new file mode 100644 index 00000000..3545e8ac Binary files /dev/null and b/content/en/blazor-webassembly-boilerplate/ui-overview/home/home.png differ diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/home/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/home/index.md new file mode 100644 index 00000000..0b2c3eeb --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/home/index.md @@ -0,0 +1,19 @@ +--- +title: "Home" +description: "Home Page in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Home Page in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-home" + name: "Home" + parent: "ui-overview" +weight: 102 +toc: true +--- + + +{{< img src="home.png" >}} diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/logs/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/logs/index.md new file mode 100644 index 00000000..9590255a --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/logs/index.md @@ -0,0 +1,18 @@ +--- +title: "Logs" +description: "Logs Page in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Logs Page in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-logs" + name: "Logs" + parent: "ui-overview" +weight: 105 +toc: true +--- + + diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/role-management/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/role-management/index.md new file mode 100644 index 00000000..f7ee428d --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/role-management/index.md @@ -0,0 +1,18 @@ +--- +title: "Role Management" +description: "Role Management Pages in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Role Management Pages in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-role-management" + name: "Role Management" + parent: "ui-overview" +weight: 107 +toc: true +--- + + diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/tenant-management/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/tenant-management/index.md new file mode 100644 index 00000000..dd255fe5 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/tenant-management/index.md @@ -0,0 +1,18 @@ +--- +title: "Tenant Management" +description: "Tenant Management Pages in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "Tenant Management Pages in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-tenant-management" + name: "Tenant Management" + parent: "ui-overview" +weight: 108 +toc: true +--- + + diff --git a/content/en/blazor-webassembly-boilerplate/ui-overview/user-management/index.md b/content/en/blazor-webassembly-boilerplate/ui-overview/user-management/index.md new file mode 100644 index 00000000..ac49e646 --- /dev/null +++ b/content/en/blazor-webassembly-boilerplate/ui-overview/user-management/index.md @@ -0,0 +1,18 @@ +--- +title: "User Management" +description: "User Management Pages in fullstackhero's Blazor WebAssembly Boilerplate." +lead: "User Management Pages in fullstackhero's Blazor WebAssembly Boilerplate." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + blazor-webassembly-boilerplate: + identifier: "ui-overview-user-management" + name: "User Management" + parent: "ui-overview" +weight: 106 +toc: true +--- + + diff --git a/content/blog/_index.md b/content/en/blog/_index.md similarity index 100% rename from content/blog/_index.md rename to content/en/blog/_index.md diff --git a/content/en/blog/say-hello-to-doks/index.md b/content/en/blog/say-hello-to-doks/index.md new file mode 100644 index 00000000..e9c31858 --- /dev/null +++ b/content/en/blog/say-hello-to-doks/index.md @@ -0,0 +1,11 @@ +--- +title: "Say hello to Doks 👋" +description: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +lead: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +date: 2020-11-04T09:19:42+01:00 +lastmod: 2020-11-04T09:19:42+01:00 +draft: false +weight: 50 +images: ["say-hello-to-doks.png"] +contributors: ["Henk Verlinde"] +--- diff --git a/content/en/blog/say-hello-to-doks/say-hello-to-doks.png b/content/en/blog/say-hello-to-doks/say-hello-to-doks.png new file mode 100644 index 00000000..70d8c786 Binary files /dev/null and b/content/en/blog/say-hello-to-doks/say-hello-to-doks.png differ diff --git a/content/contact/index.md b/content/en/contact/index.md similarity index 100% rename from content/contact/index.md rename to content/en/contact/index.md diff --git a/content/contributors/_index.md b/content/en/contributors/_index.md similarity index 63% rename from content/contributors/_index.md rename to content/en/contributors/_index.md index eebaac38..e225f344 100644 --- a/content/contributors/_index.md +++ b/content/en/contributors/_index.md @@ -1,8 +1,8 @@ --- title: "Contributors" description: "The Doks contributors." -date: 2021-08-24T11:40:05+05:30 -lastmod: 2021-08-24T11:40:16+05:30 +date: 2020-10-06T08:50:29+00:00 +lastmod: 2020-10-06T08:50:29+00:00 draft: false images: [] --- diff --git a/content/en/contributors/henk-verlinde/_index.md b/content/en/contributors/henk-verlinde/_index.md new file mode 100644 index 00000000..f775534e --- /dev/null +++ b/content/en/contributors/henk-verlinde/_index.md @@ -0,0 +1,12 @@ +--- +title: "Henk Verlinde" +description: "Creator of Hyas." +date: 2020-10-06T08:50:45+00:00 +lastmod: 2020-10-06T08:50:45+00:00 +draft: false +images: [] +--- + +Creator of Hyas. + +[@HenkVerlinde](https://twitter.com/henkverlinde) diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md new file mode 100644 index 00000000..f807c652 --- /dev/null +++ b/content/en/docs/_index.md @@ -0,0 +1,9 @@ +--- +title : "Docs" +description: "Docs Doks." +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +--- diff --git a/content/en/docs/help/_index.md b/content/en/docs/help/_index.md new file mode 100644 index 00000000..bc503ecf --- /dev/null +++ b/content/en/docs/help/_index.md @@ -0,0 +1,9 @@ +--- +title: "Help" +description: "Help Doks." +lead: "" +date: 2020-10-06T08:49:15+00:00 +lastmod: 2020-10-06T08:49:15+00:00 +draft: false +images: [] +--- diff --git a/content/en/docs/help/faq.md b/content/en/docs/help/faq.md new file mode 100644 index 00000000..f0c3bb4d --- /dev/null +++ b/content/en/docs/help/faq.md @@ -0,0 +1,50 @@ +--- +title: "FAQ" +description: "Answers to frequently asked questions." +lead: "Answers to frequently asked questions." +date: 2020-10-06T08:49:31+00:00 +lastmod: 2020-10-06T08:49:31+00:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 630 +toc: true +--- + +## Hyas? + +Doks is a [Hyas theme](https://gethyas.com/themes/) build by the creator of Hyas. + +## Footer notice? + +Please keep it in place. + +## Keyboard shortcuts for search? + +- focus: `Ctrl + /` +- select: `↓` and `↑` +- open: `Enter` +- close: `Esc` + +## Other documentation? + +- [Netlify](https://docs.netlify.com/) +- [Hugo](https://gohugo.io/documentation/) + +## Can I get support? + +Create a topic: + +- [Netlify Community](https://community.netlify.com/) +- [Hugo Forums](https://discourse.gohugo.io/) +- [Doks Discussions](https://github.com/h-enk/doks/discussions) + +## Contact the creator? + +Send `h-enk` a message: + +- [Netlify Community](https://community.netlify.com/) +- [Hugo Forums](https://discourse.gohugo.io/) +- [Doks Discussions](https://github.com/h-enk/doks/discussions) diff --git a/content/en/docs/help/how-to-update.md b/content/en/docs/help/how-to-update.md new file mode 100644 index 00000000..f9bb36b9 --- /dev/null +++ b/content/en/docs/help/how-to-update.md @@ -0,0 +1,32 @@ +--- +title: "How to Update" +description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." +lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." +date: 2020-11-12T13:26:54+01:00 +lastmod: 2020-11-12T13:26:54+01:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 610 +toc: true +--- + +{{< alert icon="💡" text="Learn more about semantic versioning and advanced range syntax." />}} + +## Check for outdated packages + +The [`npm outdated`](https://docs.npmjs.com/cli/v7/commands/npm-outdated) command will check the registry to see if any (or, specific) installed packages are currently outdated: + +```bash +npm outdated [[<@scope>/] ...] +``` + +## Update packages + +The [`npm update`](https://docs.npmjs.com/cli/v7/commands/npm-update) command will update all the packages listed to the latest version (specified by the tag config), respecting semver: + +```bash +npm update [...] +``` diff --git a/content/en/docs/help/troubleshooting.md b/content/en/docs/help/troubleshooting.md new file mode 100644 index 00000000..0d52dbb1 --- /dev/null +++ b/content/en/docs/help/troubleshooting.md @@ -0,0 +1,30 @@ +--- +title: "Troubleshooting" +description: "Solutions to common problems." +lead: "Solutions to common problems." +date: 2020-11-12T15:22:20+01:00 +lastmod: 2020-11-12T15:22:20+01:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 620 +toc: true +--- + +## Problems updating npm packages + +Delete the `./node_modules` folder, and run again: + +```bash +npm install +``` + +## Problems with cache + +Delete the temporary directories: + +```bash +npm run clean +``` diff --git a/content/en/docs/lorem/_index.md b/content/en/docs/lorem/_index.md new file mode 100644 index 00000000..86fcd8fc --- /dev/null +++ b/content/en/docs/lorem/_index.md @@ -0,0 +1,10 @@ +--- +title: "Lorem" +description: "" +lead: "" +date: 2022-01-18T19:58:14+01:00 +lastmod: 2022-01-18T19:58:14+01:00 +draft: true +images: [] +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/_index.md b/content/en/docs/lorem/ipsum/_index.md new file mode 100644 index 00000000..e575fc5c --- /dev/null +++ b/content/en/docs/lorem/ipsum/_index.md @@ -0,0 +1,15 @@ +--- +title: "Ipsum" +description: "" +lead: "" +date: 2022-01-18T20:00:32+01:00 +lastmod: 2022-01-18T20:00:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "lorem" + identifier: "ipsum" +weight: 999 +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/amet/_index.md b/content/en/docs/lorem/ipsum/amet/_index.md new file mode 100644 index 00000000..dbbeabde --- /dev/null +++ b/content/en/docs/lorem/ipsum/amet/_index.md @@ -0,0 +1,15 @@ +--- +title: "Amet" +description: "" +lead: "" +date: 2022-01-18T20:07:56+01:00 +lastmod: 2022-01-18T20:07:56+01:00 +draft: false +images: [] +menu: + docs: + parent: "ipsum" + identifier: "amet" +weight: 999 +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/amet/consectetur/index.md b/content/en/docs/lorem/ipsum/amet/consectetur/index.md new file mode 100644 index 00000000..23771e32 --- /dev/null +++ b/content/en/docs/lorem/ipsum/amet/consectetur/index.md @@ -0,0 +1,14 @@ +--- +title: "Consectetur" +description: "" +lead: "" +date: 2022-01-18T20:17:32+01:00 +lastmod: 2022-01-18T20:17:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "amet" +weight: 730 +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/dolor/index.md b/content/en/docs/lorem/ipsum/dolor/index.md new file mode 100644 index 00000000..a744e72b --- /dev/null +++ b/content/en/docs/lorem/ipsum/dolor/index.md @@ -0,0 +1,14 @@ +--- +title: "Dolor" +description: "" +lead: "" +date: 2022-01-18T20:01:45+01:00 +lastmod: 2022-01-18T20:01:45+01:00 +draft: false +images: [] +menu: + docs: + parent: "ipsum" +weight: 700 +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/sit/index.md b/content/en/docs/lorem/ipsum/sit/index.md new file mode 100644 index 00000000..e4c84e4d --- /dev/null +++ b/content/en/docs/lorem/ipsum/sit/index.md @@ -0,0 +1,14 @@ +--- +title: "Sit" +description: "" +lead: "" +date: 2022-01-18T20:05:19+01:00 +lastmod: 2022-01-18T20:05:19+01:00 +draft: false +images: [] +menu: + docs: + parent: "ipsum" +weight: 710 +toc: true +--- diff --git a/content/en/docs/prologue/_index.md b/content/en/docs/prologue/_index.md new file mode 100644 index 00000000..c3c1c40b --- /dev/null +++ b/content/en/docs/prologue/_index.md @@ -0,0 +1,9 @@ +--- +title : "Prologue" +description: "Prologue Doks." +lead: "" +date: 2020-10-06T08:48:45+00:00 +lastmod: 2020-10-06T08:48:45+00:00 +draft: false +images: [] +--- diff --git a/content/en/docs/prologue/commands.md b/content/en/docs/prologue/commands.md new file mode 100644 index 00000000..e647a98e --- /dev/null +++ b/content/en/docs/prologue/commands.md @@ -0,0 +1,98 @@ +--- +title: "Commands" +description: "Doks comes with commands for common tasks." +lead: "Doks comes with commands for common tasks." +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 130 +toc: true +--- + +{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." />}} + +## create + +Create new content for your site: + +```bash +npm run create [path] [flags] +``` + +See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/). + +## lint + +Check scripts, styles, and markdown for errors: + +```bash +npm run lint +``` + +### scripts + +Check scripts for errors: + +```bash +npm run lint:scripts [-- --fix] +``` + +### styles + +Check styles for errors: + +```bash +npm run lint:styles [-- --fix] +``` + +### markdown + +Check markdown for errors: + +```bash +npm run lint:markdown [-- --fix] +``` + +## clean + +Delete temporary directories: + +```bash +npm run clean +``` + +## start + +Start local development server: + +```bash +npm run start +``` + +## build + +Build production website: + +```bash +npm run build +``` + +### functions + +Build Lambda functions: + +```bash +npm run build:functions +``` + +### preview + +Build production website including draft and future content: + +```bash +npm run build:preview +``` diff --git a/content/en/docs/prologue/introduction.md b/content/en/docs/prologue/introduction.md new file mode 100644 index 00000000..2c0374c0 --- /dev/null +++ b/content/en/docs/prologue/introduction.md @@ -0,0 +1,58 @@ +--- +title: "Introduction" +description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize." +lead: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize." +date: 2020-10-06T08:48:57+00:00 +lastmod: 2020-10-06T08:48:57+00:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 100 +toc: true +--- + +## Get started + +Some Text + +### Tutorial + +{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." />}} + +Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/) + +### Quick Start + +{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." />}} + +One page summary of how to start a new Doks project. [Quick Start →]({{< relref "quick-start" >}}) + +## Go further + +Recipes, Reference Guides, Extensions, and Showcase. + +### Recipes + +Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/) + +### Reference Guides + +Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/) + +### Extensions + +Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/) + +### Showcase + +See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/) + +## Contributing + +Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/) + +## Help + +Get help on Doks. [Help →]({{< relref "how-to-update" >}}) diff --git a/content/en/docs/prologue/quick-start.md b/content/en/docs/prologue/quick-start.md new file mode 100644 index 00000000..9282d3ee --- /dev/null +++ b/content/en/docs/prologue/quick-start.md @@ -0,0 +1,69 @@ +--- +title: "Quick Start" +description: "One page summary of how to start a new Doks project." +lead: "One page summary of how to start a new Doks project." +date: 2020-11-16T13:59:39+01:00 +lastmod: 2020-11-16T13:59:39+01:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 110 +toc: true +--- + +## Requirements + +Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts: + +- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform. + +## Start a new Doks project + +Create a new site, change directories, install dependencies, and start development server. + +### Create a new site + +Doks is available as a child theme, and a starter theme: + +- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates. +- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates. + +Not quite sure? Use the Doks child theme. + +#### Doks child theme + +```bash +git clone https://github.com/h-enk/doks-child-theme.git my-doks-site +``` + +#### Doks starter theme + +```bash +git clone https://github.com/h-enk/doks.git my-doks-site +``` + +### Change directories + +```bash +cd my-doks-site +``` + +### Install dependencies + +```bash +npm install +``` + +### Start development server + +```bash +npm run start +``` + +Doks will start the Hugo development webserver accessible by default at `http://localhost:1313`. Saved changes will live reload in the browser. + +## Other commands + +Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}}) diff --git a/content/en/dotnet-microservices-boilerplate/_index.md b/content/en/dotnet-microservices-boilerplate/_index.md new file mode 100644 index 00000000..6fb2b86e --- /dev/null +++ b/content/en/dotnet-microservices-boilerplate/_index.md @@ -0,0 +1,10 @@ +--- +title : ".NET Microservices Boilerplate" +description: "Essential Documentation for the .NET Microservices Boilerplate project." +lead: "" +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-23T01:58:00+05:30 +draft: false +images: [] +--- +Soon! diff --git a/content/en/dotnet-microservices-boilerplate/general/overview.md b/content/en/dotnet-microservices-boilerplate/general/overview.md new file mode 100644 index 00000000..ef259764 --- /dev/null +++ b/content/en/dotnet-microservices-boilerplate/general/overview.md @@ -0,0 +1,22 @@ +--- +title: "Overview" +description: ".NET Microservices Boilerplate Template built with .NET 7.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." +lead: ".NET Microservices Boilerplate Template built with .NET 7.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-26T08:03:38+05:30 +draft: false +images: [] +menu: + dotnet-microservices-boilerplate: + identifier: "general-overview" + name: "Overview" + parent: "general" +weight: 1 +toc: true +--- + +## What's fullstackhero's .NET Microservices Boilerplate? + +Github Repository URI : [fullstackhero/dotnet-microservices-boilerplate](https://github.com/fullstackhero/dotnet-microservices-boilerplate) + +`Star the above repository and support me!` diff --git a/content/en/dotnet-webapi-boilerplate/_index.md b/content/en/dotnet-webapi-boilerplate/_index.md new file mode 100644 index 00000000..549e206e --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/_index.md @@ -0,0 +1,10 @@ +--- +title : ".NET Web API Boilerplate" +description: "Essential Documentation for the .NET Web API Boilerplate project." +lead: "" +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-23T01:58:00+05:30 +draft: false +images: [] +--- +{{< img src="fullstackhero-dotnet-webapi-banner.png" >}} diff --git a/content/en/dotnet-webapi-boilerplate/fullstackhero-dotnet-webapi-banner.png b/content/en/dotnet-webapi-boilerplate/fullstackhero-dotnet-webapi-banner.png new file mode 100644 index 00000000..36041a79 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/fullstackhero-dotnet-webapi-banner.png differ diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/_index.md b/content/en/dotnet-webapi-boilerplate/fundamentals/_index.md new file mode 100644 index 00000000..5cdc6739 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/_index.md @@ -0,0 +1,9 @@ +--- +title : "Fundamentals" +description: "fullstackhero's Web API Fundamental Features Explained." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-23T02:00:55+05:30 +lead: "" +draft: false +images: [] +--- diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/application-startup.md b/content/en/dotnet-webapi-boilerplate/fundamentals/application-startup.md new file mode 100644 index 00000000..a1e9b7af --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/application-startup.md @@ -0,0 +1,18 @@ +--- +title: "Application Startup" +description: "Understanding application-startup in fullstackhero's Web API." +lead: "Understanding Logging in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "application-startup" + name: "Application Startup" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/caching.md b/content/en/dotnet-webapi-boilerplate/fundamentals/caching.md new file mode 100644 index 00000000..1928b26b --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/caching.md @@ -0,0 +1,18 @@ +--- +title: "Caching" +description: "Understanding Caching in fullstackhero's Web API." +lead: "Understanding Caching in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "caching" + name: "Caching" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/configurations.md b/content/en/dotnet-webapi-boilerplate/fundamentals/configurations.md new file mode 100644 index 00000000..556c9400 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/configurations.md @@ -0,0 +1,182 @@ +--- +title: "Configurations" +description: "Understanding Configurations in fullstackhero's Web API." +lead: "Understanding Configurations in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "configurations" + name: "Configurations" + parent: "fundamentals" +weight: 8 +toc: true +--- +Within the Host boot project there is a folder called "Configurations". where there are all the configuration files, one for each area. + +## General Structure + +```bash +├── Host.csproj +│ ├── Configurations +│ | ├── cache.json +│ | ├── cors.json +│ | ├── database.json +│ | ├── hangfire.json +│ | ├── logger.json +│ | ├── mail.json +│ | ├── middleware.json +│ | ├── openapi.json +│ | ├── security.json +│ | ├── securityheaders.json +│ | └── signalr.json +| ├── appsettings.json +| +``` + +> The classic appsettings.json configuration file is still available to manage custom parameters. + +The **`Startup` class** inside the folder is responsible for loading all the configuration files described above. + +## Cache + +By default, the application uses in-memory cache. To enable Distributed caching with Redis, set the `UseDistributedCache` and `PreferRedis` to true and give a valid redis url! + +```json +{ + "CacheSettings": { + "UseDistributedCache": false, + "PreferRedis": false, + "RedisURL": "localhost:6379" + } +} +``` +## CORS + +Depends on the client consuming the WebAPI. + +```json +{ + "CorsSettings": { + "Angular": "http://localhost:4200", + "Blazor": "https://localhost:5002;https://www.mydomain.my", + "React": "http://localhost:3000" + } +} +``` +## Database + +By default, the dbprovider is set to postgresql. You will also have to change the connection string that is defined in hangfire.json. + +```json +{ + "DatabaseSettings": { + "DBProvider": "postgresql", + "ConnectionString": "Host=localhost;Port=5432;Database=fshDb;Username=postgres;Password=admin;Include Error Detail=true" + } +} +``` + +For details about other database providers, [refer this page](http://localhost:1313/dotnet-webapi-boilerplate/general/getting-started/#setting-up-the-connection-string) + +## Localization + +The outgoing responses can be localized using this. The client would have to pass the following header to receive localized responses. + +``` +Accept-Language: +``` + +Here, the locale-key can be anything like fr,de, it and so on. The default locale is set to english. + +```json +{ + "LocalizationSettings": { + "EnableLocalization": true, + "ResourcesPath": "Localization", + "SupportedCultures": [ + "en-US", + "en", + "fr", + "fr-FR", + "de", + "de-DE", + "it", + "it-IT", + "pt", + "nl", + "nl-NL" + ], + "DefaultRequestCulture": "en", + "FallbackToParent": true + } +} +``` + +## Logger + +FSH internally uses Serilog for logging. Here is the configuration for logger. + +```json +{ + "LoggerSettings": { + "AppName": "FSH.WebApi", + "ElasticSearchUrl": "http://localhost:9200", + "WriteToFile": true, + "StructuredConsoleLogging": false + } +} +``` + +ElasticSearchUrl -> If this is empty, serilog will ignore writing to elastic cache. +WriteToFile -> JSON structured logging to file. These log files can be found under the ./src/Host/Logs folder. +StructuredConsoleLogging -> This can be useful when deploying the application to AWS ECS, for better Cloudwatch logging. + +## Mail + +We use Ethereal, a fake SMTP Service for mocking email transactions. Don't worry, the included credentials are valid, but you can create your own as well. Check [ethereal](https://ethereal.email/) + +```json +{ + "MailSettings": { + "DisplayName": "Mukesh Murugan", + "From": "mukesh@fullstackhero.net", + "Host": "smtp.ethereal.email", + "Password": "AdEqEKB4QwWX9Xey82", + "Port": 587, + "UserName": "nestor91@ethereal.email" + } +} +``` + +### Security + +```json +{ + "SecuritySettings": { + "Provider": "Jwt", + "RequireConfirmedAccount":true, + "JwtSettings": { + "key": "S0M3RAN0MS3CR3T!1!MAG1C!1!", + "tokenExpirationInMinutes": 60, + "refreshTokenExpirationInDays": 7 + }, + "AzureAd": { + "Instance": "https://login.microsoftonline.com/", + "Domain": ".onmicrosoft.com", + "TenantId": "organizations", + "ClientId": "", + "Scopes": "access_as_user", + "RootIssuer": "https://sts.windows.net//" + }, + "Swagger": { + "AuthorizationUrl": "https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize", + "TokenUrl": "https://login.microsoftonline.com/organizations/oauth2/v2.0/token", + "ApiScope": "api:///access_as_user", + "OpenIdClientId": "" + } + } +} +``` diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/cors.md b/content/en/dotnet-webapi-boilerplate/fundamentals/cors.md new file mode 100644 index 00000000..b8afc2f2 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/cors.md @@ -0,0 +1,32 @@ +--- +title: "CORS" +description: "Understanding CORS in fullstackhero's Web API." +lead: "Understanding CORS in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "cors" + name: "CORS" + parent: "fundamentals" +weight: 11 +toc: true +--- + +CORS is an mechanism that allows a server to indicate any origins (domain, scheme, or port) other than its own. + +FullStackHero Web API has support for providing to several clients, all of the configurations related this feature can be found under `src/Host/Configurations/cors.json`. + +We present two scenarios that demonstrate how Cross-Origin requests by clients can be served: +``` +{ + "CorsSettings": { + "Angular": "http://localhost:4200", + "Blazor": "https://localhost:5002;https://www.mydomain.my" + } +} +``` + + diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/exception-handling.md b/content/en/dotnet-webapi-boilerplate/fundamentals/exception-handling.md new file mode 100644 index 00000000..2e459752 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/exception-handling.md @@ -0,0 +1,18 @@ +--- +title: "Exception Handling" +description: "Understanding Exception Handling in fullstackhero's Web API." +lead: "Understanding Exception Handling in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "exception-handling" + name: "Exception Handling" + parent: "fundamentals" +weight: 9 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/hangfire.md b/content/en/dotnet-webapi-boilerplate/fundamentals/hangfire.md new file mode 100644 index 00000000..a08818dc --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/hangfire.md @@ -0,0 +1,18 @@ +--- +title: "Hangfire" +description: "Understanding Hangfire in fullstackhero's Web API." +lead: "Understanding Hangfire in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "hangfire" + name: "Hangfire" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/localization.md b/content/en/dotnet-webapi-boilerplate/fundamentals/localization.md new file mode 100644 index 00000000..06c5ac7e --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/localization.md @@ -0,0 +1,18 @@ +--- +title: "Localization" +description: "Understanding Localization in fullstackhero's Web API." +lead: "Understanding Localization in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "localization" + name: "Localization" + parent: "fundamentals" +weight: 10 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/logging/console-logging.jpg b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/console-logging.jpg new file mode 100644 index 00000000..3e0a84fa Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/console-logging.jpg differ diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/logging/docker-elk.jpg b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/docker-elk.jpg new file mode 100644 index 00000000..5cbd5b52 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/docker-elk.jpg differ diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/logging/file-logging.jpg b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/file-logging.jpg new file mode 100644 index 00000000..7c6fb75d Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/file-logging.jpg differ diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/logging/index.md b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/index.md new file mode 100644 index 00000000..df1e4378 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/index.md @@ -0,0 +1,109 @@ +--- +title: "Logging" +description: "Understanding Logging in fullstackhero's Web API." +lead: "Understanding Logging in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-12-12T11:21:11+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "logging" + name: "Logging" + parent: "fundamentals" +weight: 11 +toc: true +--- +FullStackHero Web API has out of the box support for logging to several destinations. Thanks to the usage of Serilog! All of the configurations related to Logging can be found under `src/Host/Configurations/logger.json`. + +## Console + +Console Logging is enabled by Default. This is done directly in the C# code and not in the JSON Configurations. You can find the code snippet at the Host's Program.cs. Package used - `Serilog.Sinks.Console` + +``` +builder.Host.UseSerilog((_, config) => +{ + config.WriteTo.Console() + .ReadFrom.Configuration(builder.Configuration); +}); +``` + +Here is how the logs show up on Console via Serilog. + +{{< img src="console-logging.jpg" >}} + +## File + +Structured logging is the best part of using Serilog! It is possible to use JSON formatters to evenly log messages and warning to files in the local directory. Package used - `Serilog.Sinks.File` + +``` +"Name": "File", +"Args": { + "path": "Logs/logs.json", + "formatter": "Serilog.Formatting.Json.JsonFormatter, Serilog", + "rollingInterval": "Day", + "restrictedToMinimumLevel": "Information", + "retainedFileCountLimit": 5 +} +``` + +The above configurations ensures that the logs are structured and has a new filename every day. Since we do not want to use of a lot of memory to keep these logs, it's configured to keep the logs of the last 5 days only. Feel free to modify this. Also this only logs the messages that has a level of Information or above. + +{{< img src="file-logging.jpg" >}} + +## SEQ + +Having a dashboard to analyze the logs and warning are always good to have. SEQ is one option for that. It collects application logs, filters it as you need, along with several other integrations. + +Package used - `Serilog.Sinks.Seq` + +Make sure you have SEQ installed and running on your machine / environment. SEQ is free for Individual use. Once setup, point to the SEQ Instance. It usually runs over the `5341` port. + +``` +"Name": "Seq", +"Args": { + "serverUrl": "http://localhost:5341" +} +``` + + +{{< img src="seq-logging.jpg" >}} + +## Elastic Search + +Now, the interesting part! Elastic Search with Kibana for Logging. You will need instances of Kibana and ElasticSearch running. To make things simpler, I have included a docker-compose `deployments\elk\docker-compose.elk.yml` which has references to both Kibana and ElasticSearch Images of version `7.16.0`. + +Ensure that you have Docker installed on your machine along with the Docker Extensions for Visual Code (or your favorite IDE). From VS Code, you can simply right click `\deployments\elk\docker-compose.elk.yml` and click on Docker-Up. This would spin up the Kibana and ES instances for you in no time. + +{{< img src="docker-elk.jpg" >}} + +By default, +- Kibana runs on port 5601 - http://localhost:5601 +- Elastic Search runs on port 9200 - http://localhost:9200 + +Package used - `Serilog.Sinks.Elasticsearch` + +``` +"Name": "Elasticsearch", +"Args": { + "nodeUris": "http://localhost:9200;", + "indexFormat": "DN.WebApi-logs-{0:yyyy.MM}", + "numberOfShards": 2, + "numberOfReplicas": 1, + "restrictedToMinimumLevel": "Information" +} +``` + +You can see that we are pointing to port 9200 from our configuration. This instructs Serilog to write the logs to ElasticSearch DB. + +To view the logs on Dashboard, navigate to http://localhost:5601 + +Firstly, navigate to Kibana Spaces - http://localhost:5601/app/management/kibana/spaces + +From the sidebar, select Index Patterns and create a new one. + +In the Name field - put in `dn.webapi-logs*` or whatever you have set in your Serilog Configuration under `indexFormat`. Select the Timestamp field as `@timestamp`. That's it. + +Now, go to http://localhost:5601/app/discover + +{{< img src="kibana.jpg" >}} diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/logging/kibana.jpg b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/kibana.jpg new file mode 100644 index 00000000..bb2a2120 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/kibana.jpg differ diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/logging/seq-logging.jpg b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/seq-logging.jpg new file mode 100644 index 00000000..5264db04 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/fundamentals/logging/seq-logging.jpg differ diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/mail-service.md b/content/en/dotnet-webapi-boilerplate/fundamentals/mail-service.md new file mode 100644 index 00000000..2db770a3 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/mail-service.md @@ -0,0 +1,18 @@ +--- +title: "Mail Service" +description: "Understanding Mail Service in fullstackhero's Web API." +lead: "Understanding Mail Service in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "mail-service" + name: "Mail Service" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/middlewares.md b/content/en/dotnet-webapi-boilerplate/fundamentals/middlewares.md new file mode 100644 index 00000000..f756c615 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/middlewares.md @@ -0,0 +1,18 @@ +--- +title: "Middlewares" +description: "Understanding Middlewares in fullstackhero's Web API." +lead: "Understanding Middlewares in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "middlewares" + name: "Middlewares" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/multitenancy.md b/content/en/dotnet-webapi-boilerplate/fundamentals/multitenancy.md new file mode 100644 index 00000000..b5fc1421 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/multitenancy.md @@ -0,0 +1,18 @@ +--- +title: "Multitenancy" +description: "Understanding Multitenancy in fullstackhero's Web API." +lead: "Understanding Multitenancy in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "multitenancy" + name: "Multitenancy" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/security.md b/content/en/dotnet-webapi-boilerplate/fundamentals/security.md new file mode 100644 index 00000000..352812ef --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/security.md @@ -0,0 +1,18 @@ +--- +title: "Security" +description: "Understanding Security in fullstackhero's Web API." +lead: "Understanding Security in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "security" + name: "Security" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/signalr.md b/content/en/dotnet-webapi-boilerplate/fundamentals/signalr.md new file mode 100644 index 00000000..5fbf9c84 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/signalr.md @@ -0,0 +1,18 @@ +--- +title: "SignalR" +description: "Understanding SignalR in fullstackhero's Web API." +lead: "Understanding SignalR in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "signalr" + name: "SignalR" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/fundamentals/swagger.md b/content/en/dotnet-webapi-boilerplate/fundamentals/swagger.md new file mode 100644 index 00000000..75d39cbd --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/fundamentals/swagger.md @@ -0,0 +1,18 @@ +--- +title: "Swagger" +description: "Understanding Swagger in fullstackhero's Web API." +lead: "Understanding Swagger in fullstackhero's Web API." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "swagger" + name: "Swagger" + parent: "fundamentals" +weight: 11 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/dotnet-webapi-boilerplate/general/_index.md b/content/en/dotnet-webapi-boilerplate/general/_index.md similarity index 100% rename from content/dotnet-webapi-boilerplate/general/_index.md rename to content/en/dotnet-webapi-boilerplate/general/_index.md diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/create-brand.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/create-brand.png new file mode 100644 index 00000000..00a74f64 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/create-brand.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/get-token.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/get-token.png new file mode 100644 index 00000000..6080dce9 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/get-token.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/index.md b/content/en/dotnet-webapi-boilerplate/general/api-testing/index.md new file mode 100644 index 00000000..58a82862 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/general/api-testing/index.md @@ -0,0 +1,187 @@ +--- +title: "API Testing" +description: "Testing fullstackhero's Web API" +lead: "Testing fullstackhero's Web API" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2023-04-08T15:31:51+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "api-testing" + name: "API Testing" + parent: "general" +weight: 4 +toc: true +--- +fullstackhero's Web API can be tested via `ThunderClient`, Postman as well as the built in Swagger. + +Once the WebAPI is up and running (by default of port 5001 of localhost), here are the ways to test the functionalilty easily. + +## Swagger + +Navigate to https://localhost:5001/swagger/index.html + +{{< img src="swagger.png" >}} + +Here you can see all the available endpoints. Since all of the endpoints except the login and registration endpoints are secured, you would need a Authentication Token to access these services. + +Let's see how to generate a token via Swagger. + +You would have to the /token endpoint for this. + +{{< img src="swagger-request.png" >}} + +As mentioned earlier, the default credentials are + +``` +{ + "email":"admin@root.com", + "password":"123Pa$$word!" +} +``` + +and the default tenant is `root`. Once you send a POST request to the /token endpoint with these parameters, the API would return a valid JWT token which can be used to authenticate your further requests to various other endpoints of the API. + +Below is the response sent by the API. + +{{< img src="swagger-response.png" >}} + +Once you have the token, simply copy it , click on the Authoize button (found at the top of the Swagger UI) and paste the token as shown below. This makes sure that the token is sent alongwith all the requests as an Auth Header. + +{{< img src="swagger-header.png" >}} + + +## ThunderClient + +This is my personal favorite way to test any .NET API that I work with. This will be very helpful to you too if you use Visual Code for .NET development. Make sure that you have the ThunderClient VsCode Extension installed. + +I have included the files required for you to test the FSH WebAPI in the **./thunder-tests** folder at the root of the solution. + +{{< img src="tc-tests.png" >}} + +### Get Authentication Token + +As mentioned earlier, to the /api/tokens endpoint we POST a request with the following body and add a `tenantId = root` key to the request header. This should return a valid token from the webapi. + +``` +{ + "email": "admin@root.com", + "password": "123Pa$$word!" +} +``` + +{{< img src="get-token.png" >}} + +### Environment Variables + +{{< img src="tc-env.png" >}} + +## Postman + +Postman is also supported! + +Now that our application is up and running, let's fire up POSTMAN and run some basic requests. You can find the updated Postman collection under the /postman folder of your solution or [here](https://github.com/fullstackhero/dotnet-webapi-boilerplate/blob/main/postman/dotnet.webapi.boilerplate.postman_collection.json). Import this postman collection on to your local Postman. + +Note that I have set up some default collection variables to make things easier. + +{{< img src="postman-collection.png" >}} + +In case your application happens to start on a different Port, you would have to change the `url` variable on this collection and save it. + +### Generating Access Token + +Let's start by generating a token for the `root admin` user! Navigate to the Identity/get-token request and simply run it. If everything goes as expected, you would be seeing a valid token as your response. + +Note that here, we are passing the tenant header as `root` + +{{< img src="token-response.png" >}} + +Whenever a valid token is generated via Postman, it is stored as a variable of the collection and is used by default for all the subsequent requests via Postman until the token expires. By default, tokens have a lifetime of 60 minutes which is configurable via the `Host/Configurations/security.json` under `SecuritySettings / JwtSettings / tokenExpirationInMinutes`. + +### Search Brands + + You can test that the token is valid by sending the 'search-brands' request. + +Your request body would look somewhat like this: + +```powershell +{ + "keyword": "", + "pageNumber": 0, + "pageSize": 10, + "orderBy": [ + "id" + ] +} +``` +So, by default as soon as your application in run for the first time, a couple of Brands are seeded into the database for demo purposes. + +The *keyword* parameter in the above request denotes the keyword you want to search for in the brands table. Let's leave it empty for now and let all the other parameters stay unchanged. + +Presuming that you have a valid token you'll see: + +{{< img src="search-brand.png" >}} + +```powershell +{ + "data": [ + { + "id": "ca6247e8-3d7a-4c04-8d64-08d9f76d2c72", + "name": "Razor", + "description": "Sample Data" + }, + { + "id": "c5b447c6-a518-4268-8d65-08d9f76d2c72", + "name": "Samsung", + "description": "Sample Data" + }, + { + "id": "bb49e53d-9149-41d3-8d66-08d9f76d2c72", + "name": "MSI", + "description": "Sample Data" + }, + { + "id": "3214bf2d-9a0d-454e-8d67-08d9f76d2c72", + "name": "Huawei", + "description": "Sample Data" + } + ], + "currentPage": 1, + "totalPages": 1, + "totalCount": 4, + "pageSize": 10, + "hasPreviousPage": false, + "hasNextPage": false +} +``` +### Create a new Brand + +Let's create a new Brand. Open up Catalog/Brands/create-brand request via Postman and POST the following body. + +``` +{ + "name":"Bra1nod #29", + "description":"Something Cool!" +} +``` +Once you send your request and things work as expected, the API would send back a 200 Status Code along with your new Brand's ID as shown below. + +{{< img src="create-brand.png" >}} + +Resend the **'search-brands'** request to see your new brand listed in the response! + +### Create a new Product + +Next let's add a product. Run the **'create-product'** request at this point and you'll see a failure message: + +```powershell +{ + "source": "DN.WebApi.Application", + "exception": "brand.notfound [en-US]", + "errorCode": 404, + "succeeded": false +} +``` + +What went wrong?? Click the '**Body**' tab and look at the value for the _brandId_. That field needs to match the _ID_ value of the **Brands** table. When I created the Postman collection I had to use the values that existed while I was building the project from my workstation. If you revisit the '**search-brands**' request and look at the results you'll see a value for '_id_'. Copy that value - return to the `**create-product**' request - replace the id value with what you'd copied and re-send the command. It should report success now. diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/postman-collection.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/postman-collection.png new file mode 100644 index 00000000..649c0a11 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/postman-collection.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/search-brand.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/search-brand.png new file mode 100644 index 00000000..10c2eb89 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/search-brand.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-header.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-header.png new file mode 100644 index 00000000..2d1b8fd5 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-header.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-request.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-request.png new file mode 100644 index 00000000..f4d29ec5 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-request.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-response.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-response.png new file mode 100644 index 00000000..630e4927 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger-response.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger.png new file mode 100644 index 00000000..90c89821 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/swagger.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/tc-env.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/tc-env.png new file mode 100644 index 00000000..09c892e5 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/tc-env.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/tc-tests.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/tc-tests.png new file mode 100644 index 00000000..18e39408 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/tc-tests.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/api-testing/token-response.png b/content/en/dotnet-webapi-boilerplate/general/api-testing/token-response.png new file mode 100644 index 00000000..b676e443 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/api-testing/token-response.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/changelogs.md b/content/en/dotnet-webapi-boilerplate/general/changelogs.md new file mode 100644 index 00000000..d6e7e53f --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/general/changelogs.md @@ -0,0 +1,109 @@ +--- +title: "Changelogs" +description: "Track fullstackhero's Web API Changelogs." +lead: "Track fullstackhero's Web API Changelogs." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-10-28T10:07:45+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "changelogs" + name: "Changelogs" + parent: "general" +weight: 7 +toc: true +--- + +## 1.0.0 + +Release Tag [1.0.0](https://github.com/fullstackhero/dotnet-webapi-boilerplate/tree/1.0.0) released on `2023-04-08` + +- .NET 7 Upgrade +- FSH CLI Support +- Bug Fixes +- Code Cleanups +- Package Upgrades +- Makefile +- Built-In Docker Support +- Docker-Compose files +- Terraform for AWS ECS Deployment +- Switched Default Database Provider as PostgreSQL + +## 0.0.6-rc + +Release Tag [0.0.6-rc](https://github.com/fullstackhero/dotnet-webapi-boilerplate/tree/0.0.6-rc) released on `2022-02-26` + +- AD Authentication Support +- Oracle DB Provider for EFCore support +- Code Refactors +- Added ElasticSearch + Kibana for Logging +- Added Docker Compose for ElasticSearch + Kibana Container +- Integrated Finbucke Multitenant packages +- Solution Restructure +- Added Scripts for Generating Migrations +- Introduced CQRS Pattern with MediatR +- Better Configuration Files +- Added .rest file for API Testing +- Updated Postman Collection +- Code Cleanup +- Updated all Packages +- Serilog Startup fix +- Export to Excel Support +- Specification Pattern using Ardalis packages +- OpenAPI Client Generation + +## 0.0.5-rc + +Release Tag [0.0.5-rc](https://github.com/fullstackhero/dotnet-webapi-boilerplate/tree/0.0.5-rc) released on `2021-11-28` + +- Fixed Password Reset / Forgot +- Fixed Omnisharp Warnings / Code Cleanup +- Fixed Repository Method +- Log Hangfire to Serilog - Thanks [frankyjquintero](https://github.com/frankyjquintero) +- Extras Hangfire extensions - Thanks [frankyjquintero](https://github.com/frankyjquintero) +- Hangfire implementation examples - Thanks [frankyjquintero](https://github.com/frankyjquintero) +- Separate JSON files for each Settings - Thanks [unchase](https://github.com/unchase) +- Added Events and Handlers via MediatR - Thanks [frankyjquintero](https://github.com/frankyjquintero) +- Moved to Tenancy Middleware - Thanks [frankyjquintero](https://github.com/frankyjquintero) & [fretje](https://github.com/fretje) +- Solution Cleanup - rulesets & analyzer - Thanks [fretje](https://github.com/fretje) +- Added More Functions for RepositoryAsync - Thanks [ghaithprosoft](https://github.com/ghaithprosoft) +- Entity Database Seeding Simplified +- File-Scoped namespaces and implicit usings +- Better Folder Structure / Modular + +## 0.0.4-rc + +Release Tag [0.0.4-rc](https://github.com/fullstackhero/dotnet-webapi-boilerplate/tree/0.0.4-rc) released on `2021-11-06` + +- Bug fix in Repository / Update method. +- Endpoint changes for Update / Delete Methods. (Postman Collection Updated) +- Fixed bug in Request Logging Middleware. +- Disabled Request Logger by default to save log space. +- Adds default Role (Basic) to any new registered user. +- Basic User has default View / Search Permissions +- Code Cleanups +- Templated Emails for User Registrations + +## 0.0.3-rc + +Release Tag [0.0.3-rc](https://github.com/fullstackhero/dotnet-webapi-boilerplate/tree/0.0.3-rc) released on `2021-10-23` + +- Security Patches + +## 0.0.2-rc + +- Migration Refresh +- Security Patches +- Image Upload Fix +- Option to Disable Swagger +- Cleaner Code +- Activate / Deactivate Tenants +- Upgrade Tenant Subscription +- Advanced Search + +## 0.0.1-rc + +Release Tag [0.0.1-rc](https://github.com/fullstackhero/dotnet-webapi-boilerplate/tree/0.0.1-rc) released on `2021-09-29` + +- Initial release diff --git a/content/dotnet-webapi-boilerplate/general/development-environment.md b/content/en/dotnet-webapi-boilerplate/general/development-environment.md similarity index 76% rename from content/dotnet-webapi-boilerplate/general/development-environment.md rename to content/en/dotnet-webapi-boilerplate/general/development-environment.md index 9db8c749..4ac60bc6 100644 --- a/content/dotnet-webapi-boilerplate/general/development-environment.md +++ b/content/en/dotnet-webapi-boilerplate/general/development-environment.md @@ -3,11 +3,11 @@ title: "Development Environment" description: "Setting up the Development Environment for the .NET WebApi Boilerplate" lead: "Let's get started with setting up the Development Environment for .NET WebApi Boilerplate Development!" date: 2021-08-30T00:59:34+05:30 -lastmod: 2021-10-15T08:54:03+05:30 +lastmod: 2023-04-08T13:24:47+05:30 draft: false images: [] menu: - webapi: + dotnet-webapi-boilerplate: identifier: "general-development-environment" name: "Development Environment" parent: "general" @@ -18,11 +18,11 @@ fullstackhero's **.NET WebApi Boilerplate** Project Development needs you to hav ## .NET SDK -As mentioned earlier, this project is built with the latest available .NET SDK, which is .NET 6.0. Since the SDK is currently at preview, the project will be released by Mid-November as soon as Microsoft launches .NET 6.0 LTS SDK. But that doesn't stop you from testing out the application! +As mentioned earlier, this project is built with the latest available .NET SDK, which is .NET 7.0. -Ensure that you have the latest version of the SDK available - [Download from Microsoft](https://dotnet.microsoft.com/download/dotnet/6.0) +Ensure that you have the latest version of the SDK available - [Download from Microsoft](https://dotnet.microsoft.com/download/dotnet/7.0) -{{< alert icon="💡" text="Note : At the time of compiling this documentation, the latest version available was dotnet-sdk-6.0.100-rc.2.21505.57" />}} +{{< alert icon="💡" text="Note : At the time of compiling this documentation, the latest version available was SDK 7.0.200" />}} ## IDE @@ -45,10 +45,14 @@ Incase you intend to use Visual Studio Code for development, here are a bunch of ## Database Servers -fullstackhero's .NET WebApi Boilerplate gives you the freedom to choose between the following 3 popular Database Providers. Please note that with the current architecture of the API Project, it would rather be easy to add in support for more DB Providers with minimal change of code. But as of now, here are the 3 Supported Database Providers! By default, MSSQL is chosen as the Database Provider. +fullstackhero's .NET WebApi Boilerplate gives you the freedom to choose between the following 4 popular Database Providers. Please note that with the current architecture of the API Project, it would rather be easy to add in support for more DB Providers with minimal change of code. But as of now, here are the 4 Supported Database Providers! By default, `PostgreSQL` is chosen as the Database Provider. {{< alert text="Make sure that you have at least one of these servers installed, along with a Database Management tool like Azure Data Studio / PostgreSQL pgAdmin / MySQL Workbench " />}} +### PostgreSQL + +Probably the best Open Source Database Server with lots of Enterprise level features. +- Download postgresql Installer - [Get from postgresql.org](https://www.postgresql.org/download/) ### MSSQL @@ -58,25 +62,32 @@ There are high chances that you already have this installed on your machine. Thi - Download SQL Server Management Studio (SSMS) - [Get from Microsoft](https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-management-studio-ssms?view=sql-server-ver15) - Download Azure Data Studio to browse your MSSQL Databases - [Get from Microsoft](https://docs.microsoft.com/en-us/sql/azure-data-studio/download-azure-data-studio) - ### MySQL - Check out the Community versions of this Server - [Get from mysql](https://dev.mysql.com/downloads/mysql/) - Download MySQL Workbench - [Get from mysql](https://dev.mysql.com/downloads/workbench/) -### PostgreSQL +### Oracle -Probably the best Open Source Database Server with lots of Enterprise level features. -- Download postgresql Installer - [Get from postgresql.org](https://www.postgresql.org/download/) +- [Download](https://www.oracle.com/in/database/technologies/oracle19c-windows-downloads.html) + +## API Testing Tools -## API Testing +### POSTMAN When it comes to API Testing, Postman is the recommended tool. I have made sure to include a Postman Collection within the Repository under **/postman** folder to make sure you can test out all the existing endpoints. Note that there will be a detailed guide on how to use the given Postman Collection. - Download Postman - [Get from postman.com](https://www.postman.com/downloads/) -## Community Tools +### Thunderclient Extension + +This is my current personal favorite for testing APIs. It's lightweight when compared to Postman,and also let's you test without leaving the IDE. +If you are using Visual Code, you would love this! Search for `Thunderclient` under extensions and get it installed. + +All the required files for testing the API with thunderclient and present under **/thunder-tests** folder at the root of the solution! + +## Docker (Optional) -## Optionals +Ensure that Docker Desktop is intalled on your machine. -### Docker +[Get from docker.com](https://www.docker.com/products/docker-desktop/) diff --git a/content/en/dotnet-webapi-boilerplate/general/getting-started/folder-structure.png b/content/en/dotnet-webapi-boilerplate/general/getting-started/folder-structure.png new file mode 100644 index 00000000..0ab0ee4a Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/getting-started/folder-structure.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/getting-started/generate-solution-via-fsh-cli.png b/content/en/dotnet-webapi-boilerplate/general/getting-started/generate-solution-via-fsh-cli.png new file mode 100644 index 00000000..fd955427 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/getting-started/generate-solution-via-fsh-cli.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/getting-started/index.md b/content/en/dotnet-webapi-boilerplate/general/getting-started/index.md new file mode 100644 index 00000000..cfc650a4 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/general/getting-started/index.md @@ -0,0 +1,215 @@ +--- +title: "Getting Started 🚀" +description: "Let's get started with the .NET WebApi Boilerplate!" +lead: "Let's get started with the .NET WebApi Boilerplate!" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2023-04-08T15:32:05+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "general-getting-started" + name: "Getting Started 🚀" + parent: "general" +weight: 3 +toc: true +--- + + +

+ +Firstly, make sure that you have already setup your development environment that runs the prerequisite tools and SDKs. Refer [Development Environment](/dotnet-webapi-boilerplate/general/development-environment/) for details. + +This guide will take you right from strating up your own .NET Web API Project using `fullstackhero .NET WebAPI Boilerplate` package / repository to testing the API using the provided Postman/ThunderClient Collection! + +To get started with this Boilerplate, here are the available options. + +- Install using the `FSH CLI` tool. Use this for release versions of the Boilerplate only. +- Fork the Repository. Use this if you want to always keep your version of the Boilerplate up-to date with the latest changes. + +> Make sure that your DEV enviroment is setup, [Read the Development Environment Guide](https://fullstackhero.net/dotnet-webapi-boilerplate/general/development-environment/) + +## FSH CLI Tool + +### Prerequisites + +Before creating your first fullstackhero solution, you should ensure that your local machine has: + +- **.NET 7** You can find the download [here](https://dotnet.microsoft.com/en-us/download/dotnet/7.0). +- **NodeJS (16+)** You can find the download [here](https://nodejs.org/en/download). + +### Installation + +After you have installed .NET, you will need to install the `fsh` console tool. + +```bash +dotnet tool install --global FSH.CLI +fsh install +``` + +This install the FSH CLI tools and the associated Templates globally on your machine. You are now ready to create your first FSH project! + +Do note that, at the time of writing this documentation, the latest available version is **1.0.0** which is also one of the first stable versions of the package. It is highly likely that there is already a newer version available when you are reading this. + +> *To get the latest version of the package, visit [nuget.org](https://www.nuget.org/packages/FullStackHero.WebAPI.Boilerplate)* +> +> *FullStackHero.WebAPI.Boilerplate is now in release state. You can find the latest version on NuGet.org* + +To learn more about the FSH CLI tool, [read here](https://github.com/fullstackhero/dotnet-webapi-boilerplate/blob/main/fsh-cli/README.md) + +## Forking the Repository & Creating your New Solution! + +You would probably need to take this approach if you want to keep your source code upto date with the latest changes. To get started based on this repository, you need to get a copy locally. + +- Make a fork of fullstackhero's `dotnet-webapi-boilerplate` repository in your Github account. +- Next, since you need to start your private personal project, create your new `dotnet-webapi-boilerplate` personal project by cloning the forked repository on your personal github. This could be done as simple as running `git clone https://github.com/{yourgithubuseraccount}/dotnet-webapi-boilerplate.git` locally on your development machine. +- Setup an upstream remote on your personal project pointing to your forked repository using command `git remote add upstream https://github.com/{yourgithubuseraccount}/dotnet-webapi-boilerplate` and `git remote set-url --push upstream DISABLE` + +Now, whenever there is a new update on fullstackhero's `dotnet-webapi-boilerplate` repository, you could simply pull in the latest change on your private fork of the fullstackhero's `dotnet-webapi-boilerplate` repository and later merge these changes with you personal projects. + +For step by step instructions, [follow this](https://discord.com/channels/878181478972928011/892573122186838046/933513103688224838) and [this](https://gist.github.com/0xjac/85097472043b697ab57ba1b1c7530274). + + +### Creating your First Solution + +> Note that this is not valid only if you have installed the fsh cli tool. + +Now that you have installed the template locally on your machine, let's see how you can start generating complete .NET WebAPI Solutions seamlessly. + +Simply navigate to a new directory (wherever you want to place your new solution at), and open up Command Prompt at the opened directory. + +Run the following command. Note that, in this demonstration I am naming my new solution as `FSH.Starter`. + +```powershell +fsh api new FSH.Starter +``` + +{{< img src="generate-solution-via-fsh-cli.png" >}} + +Once that is done, your new solution is created for you. As simple as that! + +Here are the folders and files created for you. + +{{< img src="folder-structure.png" >}} + +### Alternatively.. + +> Note that this is valid only if you have installed the NuGet package of this Boilerplate. + +When you installed the NuGet package, there is also an entry that has been created into your Visual Studio Template for fullstackhero's .NET WebAPI Boilerplate. If you find it easier to work with Visual Studio rather than CLI Commands to generate new solutions, you are free to do so. + +Simply open up Visual Studio 2022 and Click on Create New Project. + +{{< img src="visual-studio-template.png" >}} + +Important - Make sure to check the 'Place solution and project in same directory' option. Else the solution and projects will be created on different folders and there will be build errors stating that few files are not found. + +{{< img src="vs-same-directory.jpg" >}} + +Another issue I noticed with creating solutions via Visual Studio is that the Solution structure might be lost. This is a very minor bug, that maybe someone can figure out and fix in our template configuration. Microsoft doesn't seem to have very detailed guide about this. + +`However, it's always recommended to create new solutions via the Console.` + +## Running the Application + +Next, open up command prompt on this directory and run the following. + +```powershell +code . +``` + +This opens up the solution via Visual Code. Make sure that you have the prerequisite tools and SDKs setup. + +### Setting up the Connection String + +Next, let's set up some valid connection strings. Navigate to `src/Host/Configurations` and open up `database.json`. Here you would have to provide a valid connection string under the `DatabaseSettings` to either MSSQL, MySQL or PostgreSQL instance. Below are some sample settings for each of the DB Providers. + +Details on the usage of other Settings will be explained in the upcoming documentations. + +`By default, FSH WebAPI tempalte ships with pre-configured PostgreSQL connection strings` + +{{< alert text="It is also important to update the src/Host/Configurations/hangfire.json connection string / provider as well." />}} + +#### PostgreSQL + +```powershell +"DatabaseSettings": { + "ConnectionString": "Host=localhost;Database=rootTenantDb;Username=postgres;Password=root;Include Error Detail=true", + "DBProvider": "postgresql" + } +``` + +#### MySQL + +```powershell +"DatabaseSettings": { + "ConnectionString": "server=localhost;uid=root;pwd=root;database=defaultRootDb;Allow User Variables=True", + "DBProvider": "mysql" + } +``` +#### MSSQL + +```powershell +"DatabaseSettings": { + "DBProvider": "mssql", + "ConnectionString": "Data Source=(localdb)\\mssqllocaldb;Initial Catalog=rootTenantDb;Integrated Security=True;MultipleActiveResultSets=True" + } +``` +#### Oracle + +```powershell +{ + "DatabaseSettings": { + "DBProvider": "oracle", + "ConnectionString": "Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=127.0.0.1)(PORT=49154))(CONNECT_DATA =(SERVER=DEDICATED)(SERVICE_NAME=ORCLPDB1.localdomain)));User Id=fullstack;Password=password123" + } +} +``` + +That's all about settings valid connection strings. + +Next, let's understand how to build & run the project! + +You can definitely use the standard ways of dotnet to build and run the application using the following commands. +```powershell + cd src/Host + dotnet build + dotnet run +``` + +`But`, for a better developer experience, I have included a Makefile within this template. You can find this file at the root `(./Makefile)`. This file contains a bunch of commands for better automation. + +Note that you will always have to be at the root of the application to execute the Makefile commands. + +## Build + +To build the solution, +``` +make build +``` + +Once that's done, let's start up the API server. + +``` +make start +``` + +{{< img src="running-api-1.png" >}} + +{{< img src="running-api-2.png" >}} + +As you can see from the logs, a couple of operations happen as soon as you launch the application. Let me give a brief idea on what happens when you run the application for the very first time. + +- The Migrations that already come out-of-the-box with the application gets applied. Note that you do not have to manually update the database using code. +- Being a Multitenant solution, the Application is programmed to seed a default Tenant named `root`, that is basically the super-admin of the entire application and has permissions to manage tenants. +- Once Tenant record is seeded, the tenant admin , roles and permissions are also seeded. Note that the default credentials for the root tenant admin are as follows. + +```powershell +{ + "email":"admin@root.com", + "password":"123Pa$$word!" +} +``` + +- The Connection String that you provided in the appSettings will be taken as the `root` Tenant's Connection. Note that all the tenant data will be stored on to this connection under the Tenants table. + diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/install-fullstackhero.jpg b/content/en/dotnet-webapi-boilerplate/general/getting-started/install-fullstackhero.jpg similarity index 100% rename from content/dotnet-webapi-boilerplate/general/getting-started/install-fullstackhero.jpg rename to content/en/dotnet-webapi-boilerplate/general/getting-started/install-fullstackhero.jpg diff --git a/content/en/dotnet-webapi-boilerplate/general/getting-started/install-fullstackhero.png b/content/en/dotnet-webapi-boilerplate/general/getting-started/install-fullstackhero.png new file mode 100644 index 00000000..7a042109 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/getting-started/install-fullstackhero.png differ diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/nuget-page.jpg b/content/en/dotnet-webapi-boilerplate/general/getting-started/nuget-page.jpg similarity index 100% rename from content/dotnet-webapi-boilerplate/general/getting-started/nuget-page.jpg rename to content/en/dotnet-webapi-boilerplate/general/getting-started/nuget-page.jpg diff --git a/content/en/dotnet-webapi-boilerplate/general/getting-started/running-api-1.png b/content/en/dotnet-webapi-boilerplate/general/getting-started/running-api-1.png new file mode 100644 index 00000000..d478dcef Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/getting-started/running-api-1.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/getting-started/running-api-2.png b/content/en/dotnet-webapi-boilerplate/general/getting-started/running-api-2.png new file mode 100644 index 00000000..a378bc7f Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/getting-started/running-api-2.png differ diff --git a/content/dotnet-webapi-boilerplate/general/getting-started/running-api.jpg b/content/en/dotnet-webapi-boilerplate/general/getting-started/running-api.jpg similarity index 100% rename from content/dotnet-webapi-boilerplate/general/getting-started/running-api.jpg rename to content/en/dotnet-webapi-boilerplate/general/getting-started/running-api.jpg diff --git a/content/en/dotnet-webapi-boilerplate/general/getting-started/visual-studio-template.png b/content/en/dotnet-webapi-boilerplate/general/getting-started/visual-studio-template.png new file mode 100644 index 00000000..5d32e027 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/getting-started/visual-studio-template.png differ diff --git a/content/en/dotnet-webapi-boilerplate/general/getting-started/vs-same-directory.jpg b/content/en/dotnet-webapi-boilerplate/general/getting-started/vs-same-directory.jpg new file mode 100644 index 00000000..f4709c07 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/general/getting-started/vs-same-directory.jpg differ diff --git a/content/en/dotnet-webapi-boilerplate/general/makefile-commands.md b/content/en/dotnet-webapi-boilerplate/general/makefile-commands.md new file mode 100644 index 00000000..c7f45e67 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/general/makefile-commands.md @@ -0,0 +1,162 @@ +--- +title: "MakeFile Commands" +description: "Here are some important MakeFile Commands that are to be used along with fullstackhero." +lead: "Here are some important MakeFile Commands that are to be used along with fullstackhero." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2023-04-08T15:44:15+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "makefile-commands" + name: "MakeFile Commands" + parent: "general" +weight: 5 +toc: true +--- + +Makefile is included within this solution to give a better developer experience. Here are the makefile commands available for this solution. + +`Note the the makefile commands have to be executed at the root of the solution where Makefile file exists.` + +## Build +```powershell +make build +``` +This would internally trigger the `dotnet build` command against the `./src/Host/Host.csproj` file. + +## Start API +```powershell +make start +``` +This boots up the WebAPI at http://localhost:5001. Make sure that you have your API COnnection strings configured before you run this command. + +## Nuget +```powershell +make nuget +``` +This packs your Solution into a nuget package. The required .template.config folder is not included as part of the solution generated by the fsh tool, since the nuget part wont be used by many. You can get the folder in the fullstackhero dotnet webapi github repository. + +## Publish Docker Image +```powershell +make publish +``` +Using .NET 7's Built-In Containerization feature, this command builds the docker image for you using the `dotnet publish` command internally. Here is how to setup the metadata of your docker image. + +Navigate to src/Host/Host.csproj file and modify the following as per your requirement. + +``` + + dotnet-webapi + 1.0.0;latest + DefaultContainer + +``` + +So, my image name is dotnet-webapi and the image will be tagged with 1.0.0 and latest. + +Ensure that you have docker instances running before you execute this command. + +## Build & Publish to Docker Hub + +Similar to the previous command, you can build and push docker images directly to docker hub. In this case, you really dont need a docker instance running to build your docker image. + +```powershell +make publish-to-hub +``` +Note : Currently, the docker repository is set to mine. You can modify this to yours in the Makefile. + +### Terraform & AWS Deployments + +The terraform scripts are available at the `./terraform` folder. + +#### Prerequisites +- Install Terraform +- Install & Configure AWS CLI profiles to allow terraform to provision resources for you. I have made a video about [AWS Credentials Management](https://www.youtube.com/watch?v=oY0-1mj4oCo&ab_channel=MukeshMurugan). + +The fullstackhero webapi boilerplate comes with built-in terraform scripts to provision docker containers with your webapi image to aws infrastructure with just one line of command! + +Your images will be deployed to an ECS Container (FARGATE) and an RDS instance with postgresql engine would be spun up, to which your webapi container will connect to! + +In brief, the terraform folder has 2 sub-folders. +- backend +- environments/staging + +The Backend folder is internally used by Terraform for state management and locking. There is a one-time setup you have to do against this folder. Navigate to the backend folder and run the command. + +``` +terraform init +terraform apply -auto-approve +``` + +This would create the required S3 Buckets and DDB table for you. + +Next is the `environments/staging` folder. Here too, run the following command. + +``` +terraform init +``` + +Once done, you can go the terraform.tfvars file to change the variables like, +- project tags +- docker image name +- ecs cluster name and so on. + +After that, simply navigate back to the root of the solution and run the following commands. + +#### Terraform Plan + +The below command gives you the plan of resources that needs to be created/modified/deleted in the aws world. + +```powershell +make tp +``` + +#### Terraform Apply + +This command will provision resources into AWS for you. + +```powershell +make ta +``` + +The resources are as follows: +1. ECS Cluster +2. ECS Task Definitions +3. ECS Service +4. Cloudwatch Log Groups +5. RDS Instance with Postgresql Engine +6. VPC & related resources +7. Load Balancers + +Once the command has completed, you will be getting an API URL, which you can use for testing! + +#### Terraform Destroy + +The below commands destroys all the resources created, related to fullstackhero. + +```powershell +make td +``` + +## Migrations +This command is to be executed from the Host Directory of the project. + +```powershell +dotnet ef migrations add --project .././Migrators/Migrators./ --context ApplicationDbContext -o Migrations/Application +``` +CommitMessage : Enter a commit message here. +Provider : Enter the available DB Provider name. MSSQL , MySQL , PostgreSQL , Oracle + +While adding migrations for a particular provider, ensure that you have configured a valid connection string to the provider's database at both `src/Host/Configurations/database.json` and `src/Host/Configurations/hangfire.json`. + +## Docker Compose + +This project also comes with examples of docker compose files, where you can spin up the webapi and database instance in your local containers with the following commands. + +```powershell +make dcu #docker compose up - Boots up the webapi & postgresql container +make dcd #docker compose down - Shuts down the webapi & postgresql containers +``` + +There are also examples for mysql & mssql variations of the fsh webapi. You can find the other docker-compose files under the ./docker-compose folder. Read more about [fullstackhero's docker-compose instructions & files here](https://github.com/fullstackhero/dotnet-webapi-boilerplate/blob/main/docker-compose/README.md) diff --git a/content/en/dotnet-webapi-boilerplate/general/overview.md b/content/en/dotnet-webapi-boilerplate/general/overview.md new file mode 100644 index 00000000..e28dee85 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/general/overview.md @@ -0,0 +1,324 @@ +--- +title: "Overview" +description: ".NET WebAPI Boilerplate Template built with .NET 7.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." +lead: ".NET WebAPI Boilerplate Template built with .NET 7.0. Incorporates the most essential Packages your projects will ever need. Follows Clean Architecture Principles." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2023-04-08T13:35:10+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "general-overview" + name: "Overview" + parent: "general" +weight: 1 +toc: true +--- + + +## What's fullstackhero's .NET Web API Boilerplate? + +fullstackhero's .NET Web API Boilerplate is a starting point for your next `.NET 7 Clean Architecture Project` that incorporates the most essential packages and features your projects will ever need including out of the box Multi-Tenancy support. This project can save well over `200+ hours` of development time for your team. + +> As the name suggests, this is an API / Server Boilerplate. You can find other Client Boilerplates that consume this API under `@fullstackhero` handle. +> - Find `Blazor WebAssembly Boilerplate` here - https://github.com/fullstackhero/blazor-wasm-boilerplate + +## Goals + +The goal of this repository is to provide a complete and feature-rich starting point for any .NET Developer / Team to kick-start their next major project using .NET 7 Web API. This also serves the purpose of learning advanced concepts and implementations such as `Multitenancy, CQRS, Onion Architecture, Clean Coding standards, Cloud Deployments with Terraform to AWS, Docker Concepts, CICD Pipelines & Workflows` and so on. + +## Features + +- [x] Built on .NET 7.0 +- [x] Follows Clean Architecture Principles +- [x] Domain Driven Design +- [x] Cloud Ready. Can be deployed to AWS Infrastructure as ECS Containers using Terraform! +- [x] Docker-Compose File Examples +- [x] Documented at [fullstackhero.net](https://fullstackhero.net) +- [x] Multi Tenancy Support with Finbuckle + - [x] Create Tenants with Multi Database / Shared Database Support + - [x] Activate / Deactivate Tenants on Demand + - [x] Upgrade Subscription of Tenants - Add More Validity Months to each tenant! +- [x] Supports MySQL, MSSQL, Oracle & PostgreSQL! + +

+ Click to See More! + +- [x] Uses Entity Framework Core as DB Abstraction +- [x] Flexible Repository Pattern +- [x] Dapper Integration for Optimal Performance +- [x] Serilog Integration with various Sinks - File, SEQ, Kibana +- [x] OpenAPI - Supports Client Service Generation +- [x] Mapster Integration for Quicker Mapping +- [x] API Versioning +- [x] Response Caching - Distributed Caching + REDIS +- [x] Fluent Validations +- [x] Audit Logging +- [x] Advanced User & Role Based Permission Management +- [x] Code Analysis & StyleCop Integration with Rulesets +- [x] JSON Based Localization with Caching +- [x] Hangfire Support - Secured Dashboard +- [x] File Storage Service +- [x] Test Projects +- [x] JWT & Azure AD Authentication +- [x] MediatR - CQRS +- [x] SignalR Notifications +- [x] & Much More +
+ +## Documentation + +Read Documentation related to this Boilerplate here - https://fullstackhero.net/dotnet-webapi-boilerplate/ +> Feel free to contribute to the Documentation Repository - https://github.com/fullstackhero/docs + +## Getting Started + +To get started with this Boilerplate, here are the available options. + +- Install using the `FSH CLI` tool. Use this for release versions of the Boilerplate only. +- Fork the Repository. Use this if you want to always keep your version of the Boilerplate up-to date with the latest changes. + +> Make sure that your DEV enviroment is setup, [Read the Development Environment Guide](https://fullstackhero.net/dotnet-webapi-boilerplate/general/development-environment/) + +### FSH CLI Tool + +#### Prerequisites + +Before creating your first fullstackhero solution, you should ensure that your local machine has: + +- **.NET 7** You can find the download [here](https://dotnet.microsoft.com/en-us/download/dotnet/7.0). +- **NodeJS (16+)** You can find the download [here](https://nodejs.org/en/download). + +#### Installation + +After you have installed .NET, you will need to install the `fsh` console tool. + +```bash +dotnet tool install --global FSH.CLI +fsh install +``` + +This isntall the FSH CLI tools and the associated Templates. You are now ready to create your first FSH project! + +#### FSH .NET WebAPI Boilerplate +Here's how you would create a Solution using the FSH .NET WebAPI Boilerplate. + +Simply navigate to a new directory (wherever you want to place your new solution), and open up Command Prompt at the opened directory. + +Run the following command. Note that, in this demonstration, I am naming my new solution as FSH.Starter. + +```bash +fsh api new FSH.Starter +``` + +OR + +```bash +fsh api n FSH.Starter +``` + +This will create a new .NET 7 WEBAPI solution for you using the FSH Templates. +For further steps and details, [Read the Getting Started Guide](https://fullstackhero.net/dotnet-webapi-boilerplate/general/getting-started/) + +#### Update +To update the tool & templates, run the following commands +```bash +dotnet tool update FSH.CLI --global +fsh update +``` +### Forking the Repository + +You would probably need to take this approach if you want to keep your source code upto date with the latest changes. To get started based on this repository, you need to get a copy locally. You have three options: fork, clone, or download. + +- Make a fork of this repository in your Github account. +- Create your new `dotnet-webapi-boilerplate` personal project by cloning the forked repository on your personal github. +- Setup an upstream remote on your personal project pointing to your forked repository using command `git remote add upstream https://github.com/{githubuseraccount}/dotnet-webapi-boilerplate` and `git remote set-url --push upstream DISABLE` + +For step by step instructions, [follow this](https://discord.com/channels/878181478972928011/892573122186838046/933513103688224838) and [this](https://gist.github.com/0xjac/85097472043b697ab57ba1b1c7530274). + + +## Quick Start Guide + +So, for a better developer experience, I have added Makefile into the solution. Now that our solution is generated, let's navigate to the root folder of the solution and open up a command terminal. + +To build the solution, +``` +make build +``` + +By default, the solution is configured to work with postgresql database (mainly because of hte OS licensing). So, you will have to make sure that postgresql database instance is up and running on your machine. You can modify the connection string to include your username and password. Connections strings can be found at `src/Host/Configurations/database.json` and `src/Host/Configurations/hangfire.json`. Once that's done, let's start up the API server. + +``` +make start +``` + +That's it, the application would connect to the defined postgresql database and start creating tables, and seed required data. + +For testing this API, we have 3 options. +1. Swagger @ `localhost:5001/swagger` +2. Postman collections are available `./postman` +3. ThunderClient for VSCode. This is my personal favorite. You will have to install the Thunderclient extension for VSCode. + +The default credentials to this API is: + + +```json +{ + "email":"admin@root.com", + "password":"123Pa$$word!" +} +``` + +Open up Postman, Thunderclient or Swagger. + +identity -> get-token + +This is a POST Request. Here the body of the request will be the JSON (credentials) I specified earlier. And also, remember to pass the tenant id in the header of the request. The default tenant id is `root`. + +Here is a sample CURL command for getting the tokens. + +```curl +curl -X POST \ + 'https://localhost:5001/api/tokens' \ + --header 'Accept: */*' \ + --header 'tenant: root' \ + --header 'Accept-Language: en-US' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "email": "admin@root.com", + "password": "123Pa$$word!" +}' +``` + +And here is the response. + +```json +{ + "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjM0YTY4ZjQyLWE0ZDgtNDNlMy1hNzE3LTI1OTczZjZmZTJjNyIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6ImFkbWluQHJvb3QuY29tIiwiZnVsbE5hbWUiOiJyb290IEFkbWluIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InJvb3QiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zdXJuYW1lIjoiQWRtaW4iLCJpcEFkZHJlc3MiOiIxMjcuMC4wLjEiLCJ0ZW5hbnQiOiJyb290IiwiaW1hZ2VfdXJsIjoiIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbW9iaWxlcGhvbmUiOiIiLCJleHAiOjE2ODA5NDE3MzN9.VYNaNvk2T4YDvQ3wriXgk2W_Vy9zyEEhjveNauNAeJY", + "refreshToken": "pyxO30zJK8KelpEXF0vPfbSbjntdlbbnxrZAlUFXfyE=", + "refreshTokenExpiryTime": "2023-04-15T07:15:33.5187598Z" +} +``` + +You will need to pass the `token` in the request headers to authenticate calls to the fullstackhero API! + +For further steps and details, [Read the Getting Started Guide](https://fullstackhero.net/dotnet-webapi-boilerplate/general/getting-started/) + +## Containerization + +The API project, being .NET 7, it is configured to have built-in support for containerization. That means, you really don't need a Dockerfile to containerize the webapi. + +To build a docker image, all you have to do is, ensure that docker-desktop or docker instance is running. And run the following command at the root of the solution. + +``` +make publish +``` + +You can also push the docker image directly to dockerhub or any supported registry by using the following command. + +``` +make publish-to-hub +``` +You will have to update your docker registry / repo url in the Makefile though!. + +## Docker Compose + +This project also comes with examples of docker compose files, where you can spin up the webapi and database isntance in your local containers with the following commands. + +```powershell +make dcu #docker compose up - Boots up the webapi & postgresql container +make dcd #docker compose down - Shuts down the webapi & postgresql containers +``` + +There are also examples for mysql & mssql variations of the fsh webapi. You can find the other docker-compose files under the ./docker-compose folder. Read more about [fullstackhero's docker-compose instructions & files here](./docker-compose/README.md) + +## Cloud Deployment with Terraform + AWS ECS + +This is something you wont get to see very often with boilerplates. But, we do support cloud deployment to AWS using terraform. The terraform files are available at the `./terraform` folder. + +### Prerequisites +- Install Terraform +- Install & Configure AWS CLI profiles to allow terraform to provision resources for you. I have made a video about [AWS Credentials Management](https://www.youtube.com/watch?v=oY0-1mj4oCo&ab_channel=MukeshMurugan). + +In brief, the terraform folder has 2 sub-folders. +- backend +- environments/staging + +The Backend folder is internally used by Terraform for state management and locking. There is a one-time setup you have to do against this folder. Navigate to the backend folder and run the command. + +``` +terraform init +terraform apply -auto-approve +``` + +This would create the required S3 Buckets and DDB table for you. + +Next is the `environments/staging` folder. Here too, run the following command. + +``` +terraform init +``` + +Once done, you can go the terraform.tfvars file to change the variables like, +- project tags +- docker image name +- ecs cluster name and so on. + +After that, simply back to the root of the solution and run the following command. + +``` +make ta +``` + +This will evaluate your terraform files and create a provision plan for you. Once you are ok, type in `yes` and the tool will start to deploy your .NET WebAPI project as containers along with a RDS PostgreSQL intance. You will be receiving the hosted api url once the provisioning is completed! + +To destroy the deployed resources, run the following +``` +make td +``` + +## Important Links & Documentations + +Overview - [Read](https://fullstackhero.net/dotnet-webapi-boilerplate/general/overview/) + +Getting Started - [Read](https://fullstackhero.net/dotnet-webapi-boilerplate/general/getting-started/) + +Development Environment - [Learn about setting up the DEV environment](https://fullstackhero.net/dotnet-webapi-boilerplate/general/development-environment/) + +Participate in Discussions - [QNA & General Discussions](https://github.com/fullstackhero/dotnet-webapi-boilerplate/discussions) + +Join our Discord - [fullstackhero @ Discord](https://discord.gg/gdgHRt4mMw) + +## Changelogs + +[View Complete Changelogs.](https://github.com/fullstackhero/dotnet-webapi-boilerplate/blob/main/CHANGELOGS.md) + +## Community + +- Discord [@fullstackhero](https://discord.gg/gdgHRt4mMw) +- Facebook Page [@codewithmukesh](https://facebook.com/codewithmukesh) +- Youtube Channel [@codewithmukesh](https://youtube.com/c/codewithmukesh) + +## Contributors + +Submit your PR and join the elite list! + + + + + +## License + +This project is licensed with the [MIT license](https://github.com/fullstackhero/dotnet-webapi-boilerplate/blob/main/LICENSE). + +## Support ⭐ + +Has this Project helped you learn something New? or Helped you at work? +Here are a few ways by which you can support. + +- Leave a star! ⭐ +- Recommend this awesome project to your colleagues. đŸĨ‡ +- Do consider endorsing me on LinkedIn for ASP.NET Core - [Connect via LinkedIn](https://codewithmukesh.com/linkedin) đŸĻ¸ +- Sponsor the project - [opencollective/fullstackhero](https://opencollective.com/fullstackhero) ❤ī¸ +- Or, [consider buying me a coffee](https://www.buymeacoffee.com/codewithmukesh)! ☕ + diff --git a/content/en/dotnet-webapi-boilerplate/general/project-structure/index.md b/content/en/dotnet-webapi-boilerplate/general/project-structure/index.md new file mode 100644 index 00000000..bf242378 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/general/project-structure/index.md @@ -0,0 +1,99 @@ +--- +title: "Project Structure" +description: "Here is how the .NET WebApi Boilerplate is structured." +lead: "Here is how the .NET WebApi Boilerplate is structured." +date: 2021-08-24T11:40:05+05:30 +lastmod: 2021-11-28T17:35:38+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "general-project-structure" + name: "Project Structure" + parent: "general" +weight: 6 +toc: true +--- + +fullstackhero's .NET WebApi Boilerplate is based on Clean Architecture. In other words, Onion / Hexagonal Architecture. [Read about the advantages and principles of Onion Architecture here →](https://codewithmukesh.com/blog/onion-architecture-in-aspnet-core/) + +## General Structure + +This means that the entire solution is built in such a way that it can be scaled, maintained easily by teams of developers. This WebAPI Solution Primarily consists of the following .csproj files. + +```bash + +├── src +│ ├── Host +| | └── Host.csproj +│ ├── Core +│ | ├── Application.csproj +│ | ├── Shared.csproj +│ | └── Domain.csproj +| ├── Infrastructure +| | └── Infrastructure.csproj +| ├── Migrators +│ | ├── Migrators.MSSQL.csproj +│ | ├── Migrators.MySQL.csproj +│ | ├── Migrators.PostgreSQL.csproj +│ | └── Migrators.Oracle.csproj + +``` + +The idea is to build a very loosely coupled architecture following best practices and packages. Let's see in brief what responsibilities each of these projects handle. + +### Host + +Contains the API Controllers and Startup Logic including ASP.NET Core Container setup. This is the entry point of the application. Also, other static files like the logs, localization jsons, images, email templates and most importantly the configuration files live under this project. + +With the release of 0.0.5-rc, the appSettings.json is further split into variable sub-setting like database.json, security.json and so on for better modularity and organization. You can find these new JSONs under the Configurations folder of the Host project. + +```bash +├── Host +| ├── Configurations +| ├── Controllers +| ├── Email Templates +| ├── Extensions +| ├── Files +│ | ├── Images +│ | └── Documents +| ├── Localization +| ├── Logs +| └── appsettings.json +``` + +Note that the *Host* project depends on +- Application +- Infrastructure +- Migration Projects + +### Application + +This is one of the projects in the Core Folder apart from the Domain Project. Here you get to see Abstract Classes and Interfaces that are inherited and implemented in the Infrastructure Project. This refers to Dependency Inversion. + +``` bash +├── Core +| ├── Application +| | ├── Auditing +| | ├── Catalog +| | ├── Common +| | ├── Dashboard +| | ├── Identity +| | └── Multitenancy + +``` + +The folders and split at the top level Feature-wise. Meaning, it now makes it easier for developers to understand the folder structure. Each of the feature folders like Catalog will have all the files related to it's scope including validators, dtos, interfaces and so on. + +Thus everything related to a feature will be found directly under that Feature folder. + +In cases where there are less number of classes / interfaces associated with a feature, all of these classes are put directly under the root of the feature folder. Only when the complexity of the feature increases, it is recommended to separate the classes by their type. + +Note that the *Application* project depends only on the Core projects which are `Shared` and `Domain`. + +### Domain + +Note that the *Domain* project does not depend on any other project other than the `Shared` project. + +As per Clean Architecture principles, the Core of this Solution i.e, Application and Domain projects do not depend on any other projects. This helps achieve Dependency Inversion (The 'D' Principle of 'SOLID'). + diff --git a/content/dotnet-webapi-boilerplate/tutorials/_index.md b/content/en/dotnet-webapi-boilerplate/tutorials/_index.md similarity index 100% rename from content/dotnet-webapi-boilerplate/tutorials/_index.md rename to content/en/dotnet-webapi-boilerplate/tutorials/_index.md diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-1.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-1.png new file mode 100644 index 00000000..5c57fba8 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-1.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-2.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-2.png new file mode 100644 index 00000000..89b6675b Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-2.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-3.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-3.png new file mode 100644 index 00000000..748265de Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-permission-3.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-1.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-1.png new file mode 100644 index 00000000..5b63b4e3 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-1.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-2.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-2.png new file mode 100644 index 00000000..2ad8e21a Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-2.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-3.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-3.png new file mode 100644 index 00000000..349bacd8 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/add-scope-3.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/assign-app-roles-1.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/assign-app-roles-1.png new file mode 100644 index 00000000..ef581c53 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/assign-app-roles-1.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/assign-app-roles-2.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/assign-app-roles-2.png new file mode 100644 index 00000000..853cbeb3 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/assign-app-roles-2.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/create-app-role-1.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/create-app-role-1.png new file mode 100644 index 00000000..4f828f6c Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/create-app-role-1.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/create-app-role-2.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/create-app-role-2.png new file mode 100644 index 00000000..006d3c25 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/create-app-role-2.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/index.md b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/index.md new file mode 100644 index 00000000..ab253397 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/index.md @@ -0,0 +1,133 @@ +--- +title: "Setting up Azure AD Authentication" +description: "Setting up Azure AD Authentication with fullstackhero's Web API" +lead: "Setting up Azure AD Authentication with fullstackhero's Web API" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2021-11-29T00:44:06+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "azure-ad-guide" + name: "Azure AD Authentication" + parent: "tutorials" +weight: 12 +toc: true +--- + +For the Azure AD integration to work with this template, you have to create 2 `App Registrations` under your Azure AD tenant with the right settings, and then fill out the `AzureAd` section in `Configurations/security.json` to hook those apps up. This guide will walk you through doing all that. + +## Create the FSHApi Application Registration + +* Log into the azure portal and go to the [Azure Active Directory blade](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade). Make sure you are in the directory where you want your apps to be registered. You can switch directories by clicking on your account info in the top right corner. + +* Under `Manage`, click on `App registrations`, and click the `New registration` button on top: +{{< img src="new-registration.png" >}} + +* Fill in `FSHApi` (or whichever name you want for this app) as `Name`. Under `Supported account types` select `Accounts in any organizational directory - Multitenant` and click on `Register`: +{{< img src="register-api.png" >}} + +### Expose the Api + +* On the newly created App's blade, under `Manage`, click on `Expose an API`, then click on `Add a scope`: +{{< img src="add-scope-1.png" >}} + +* An `Application ID URI`q will automatically be filled out. Click on `Save and continue`: +{{< img src="add-scope-2.png" >}} + +* On the next screen, fill in `access_as_user` as `Scope name`, select `Admins and users` as `Who can consent?` and fill out the display names and descriptions like in the screenshot below, then click on `Add scope`: +{{< img src="add-scope-3.png" >}} + +### Add App roles + +* Under `Manage`, click on `App roles` and click the `Create app role` button on top: +{{< img src="create-app-role-1.png" >}} + +* Fill in `Administrators` as Display name and `Admin` as value. Especially the value is important, as this has to match the name of the role in the FSH application itself. Click on Apply: +{{< img src="create-app-role-2.png" >}} + +* In the same way, create app roles for the other roles in your application (by default the only other role is the `Basic` role). + +## Assign App roles to specific users in AzureAD + +You will have to assign those freshly created App roles to the AzureAd users to which you want to grant access to your application: + +* On the [Azure Active Directory blade](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade), under `Manage` click on `Enterprise applications` and select the FSHApi application: +{{< img src="assign-app-roles-1.png" >}} + +* Under `Manage`, click on `Users and groups` and click the `Add user/group` button on top: +{{< img src="assign-app-roles-2.png" >}} + +* On the next screen, you can select one or more users/groups, select an App role and click on the `Assign` button to assign the role the the specified users/groups. + +## Create the Client Application Registration + +* Go back again to the [Azure Active Directory blade](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade) and under `Manage`, click on `App registrations`, and click the `New registration` button on top again. + +* This time, fill out `FSHClient` as Name, choose again for `Accounts in any organizational directory - Multitenant` and under `Redirect URI`, select `Single-page application (SPA)` and fill out the url `https://localhost:5001/swagger/oauth2-redirect.html`. Click on `Register`: +{{< img src="register-api.png" >}} + +### Add permission for the Api + +* On the newly created App's blade, under `Manage`, click on `API permissions` and click the `Add a permission` button: +{{< img src="add-permission-1.png" >}} + +* On the next view, under `Select an API`, click on `My APIs` and select FSHApi: +{{< img src="add-permission-2.png" >}} + +* Then, under `Select permissions`, check the `access_as_user` permission and click on `Add permissions`: +{{< img src="add-permission-3.png" >}} + +### Add Blazor Client application + +This should be enough for testing from swagger. But you'll probably will want to use the client application as well. There's 2 options here. Or you can add the `Redirect URI` for the client application to the same App registration you just created (click on `Authentication` under `Manage` and then on `Add URI`), or you can create a whole new client app registration specifically for this client, just like described in the steps above, but with another `Redirect URI`. In any case, the `Redirect URI` for the blazor app you will want to use is `https://localhost:5002/authentication/login-callback`. + +## Update the AzureAd settings on the Web Api project + +Now that's all set up, the only thing left is updating the configuration to use AzureAd. +On the Web API project, under `src\Host\Configurations`, open `security.json` and fill out the required settings: + +* `Provider`: set to `AzureAd` +* `Instance`: set to `https://login.microsoftonline.com/` +* `Domain`: you can find your domain in the Azure Active Directory blade on the `Overview` page under `Primary domain`. +* `TenantId`: set to `organizations` +* `ClientId`: set to the `Application (client) ID` of the FSHApi App registration (you can find this on the `Overview` page of the App registration in Azure) +* `Scopes`: set to `access_as_user` +* `RootIssuer`: set to `https://sts.windows.net//` (your `Tenant ID` is also on the `Overview` page of the Azure Active Directory blade) + +Then for swagger to work you need the following settings under the `Swagger` node in `security.json`: + +* `AuthorizationUrl`: set to `https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize` +* `TokenUrl`: set to `https://login.microsoftonline.com/organizations/oauth2/v2.0/token` +* `ApiScope`: set to the full name of the api scope we created in the FSHApi App registration above (`api:///access_as_user`) +* `OpenIdClientId`: set to the `Application (client) ID` of the FSHClient App registration (or the one you specifically created for swagger). + +## Update the AzureAd settings on the Blazor Client project + +Then for the blazor client to work, you need the following settings over there in the `wwwroot/appsettings.json` file: + +* `AuthProvider`: set to `AzureAd` +* `Authority`: set to `https://login.microsoftonline.com/organizations` +* `ClientId`: set to the `Application (client) ID` of the FSHClient App registration (or the one you specifically created for the blazor client). +* `ValidateAuthority`: set to `true` +* `ApiScope`: set to the full name of the api scope we created in the FSHApi App registration (`api:///access_as_user`) same as before with the swagger client. + +## Configuration for Postman + +TODO - Coming soon + +## Test it out + +* Start the Web API project and browse to `https://localhost:5001/swagger` when you click on the `Authorize` button on the top right, you should be redirected to the Microsoft login site. Log in with a user to which you granted app roles and you should be redirected back to swagger with the padlock closed. When you now issue an api call, the Authorization header should be sent with the bearer token received from AzureAd. + +* Start the Blazor Client project and browse to `https://localhost:5002/`. You should be immediately redirected to the Microsoft login site. And after logging in, you should be redirected back to the homepage of the blazor client. + +## AzureAd and multitenancy + +About the `RootIssuer`setting in `security.json`. This should be set to the issuer of the root tenant in AzureAd. When someone is logging in from that AzureAD tenant, the local root tenant will automatically be selected. + +For the other tenants there's an "issuer" field in the tenants table to map those. There's still a part which has to be implemented for mutltiple tenants from AzureAd though, as there needs to be some kind of "onboarding" experience inside AzureAD when a new tenant needs access to you application. See https://docs.microsoft.com/en-us/azure/architecture/multitenant-identity/signup for more info about this. + +## AzureAd users/roles vs. local users/roles + +In any case, with AzureAd, when a user logs in and there doesn't exist a local user yet in the local tenant for that AzureAd user/tenant, one gets created automatically. It will also immediately have the same roles assigned like the ones in AzureAd. When an already existing user logs in and there are roles in AzureAd for that user which are not yet assigned to the local user, they will automatically be assigned. Currently there will never be any roles removed from a user. So removing the role assignment from AzureAd will not automatically remove it from the local user when he logs in. This to allow for people to use the role/permission management inside the app without having to do it in Azure. diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/new-registration.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/new-registration.png new file mode 100644 index 00000000..04975093 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/new-registration.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/register-api.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/register-api.png new file mode 100644 index 00000000..ac25877e Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/register-api.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/register-client.png b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/register-client.png new file mode 100644 index 00000000..42ac9322 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/azure-ad-guide/register-client.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/crud-guide/index.md b/content/en/dotnet-webapi-boilerplate/tutorials/crud-guide/index.md new file mode 100644 index 00000000..c6ff04d0 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/tutorials/crud-guide/index.md @@ -0,0 +1,18 @@ +--- +title: "Performing CRUD Operations" +description: "Performing CRUD Operations with fullstackhero's Web API" +lead: "Performing CRUD Operations with fullstackhero's Web API" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2021-11-29T00:44:06+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "crud-guide" + name: "Implementing CRUD" + parent: "tutorials" +weight: 12 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/database-migrations/index.md b/content/en/dotnet-webapi-boilerplate/tutorials/database-migrations/index.md new file mode 100644 index 00000000..1e00b9fb --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/tutorials/database-migrations/index.md @@ -0,0 +1,115 @@ +--- +title: "Adding Database Migrations for Entity Framework Core" +description: "Adding Database Migrations for Entity Framework Core with fullstackhero's Web API" +lead: "Adding Database Migrations for Entity Framework Core with fullstackhero's Web API" +date: 2022-01-15T21:31:40+05:30 +lastmod: 2022-01-15T21:31:44+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "database-migrations" + name: "Database Migrations" + parent: "tutorials" +weight: 12 +toc: true +--- + +So, you have already added new entities into the Domain project, modified an existing entity or want to recreate all the pre-generated migrations? Here is how to proceed. + +Note that currently, fullstackhero's Web API supports the following major DB Providers, +1. MSSQL +2. MySQL +3. PostgreSQL +4. Oracle + +Download links to setup the supported Database providers are mentioned here - https://fullstackhero.net/dotnet-webapi-boilerplate/general/development-environment/ + +To maintain scalability, the database migrations of each of these DB Providers are kept in separate class library projects namely +1. Migrators/Migrators.MSSQL +2. Migrators/Migrators.MySQL +3. Migrators/Migrators.PostgreSQL +4. Migrators/Migrators.Oracle + +Out of the box, the default migrations are already generated and is made available for you. This means you would'nt even have to run a `update-database` to get started. The Application startup already handles it for you. + +As of now, fullstackhero's Web API consists of the following EF Core DB Context classes, +1. ApplicationDbContext - This is where you would ideally reference your new entities. By default, Catalog entities are referenced here. +2. TenantDbContext - Related to Finbuckle's Multitenancy setup of Stores. + +which are maintained as 2 different sub-folders under each of the Migrator projects named as `Application` and `Tenant` folders. + +To start with generating the database migrations, open your terminal on to the Host Project. + +Note that steps are almost same for all the Database providers. But make sure that you got to have the respective connection string of the Database Provider in the `database.json` and `hangfire.json` to continue. + +Meaning, if you intend to create / update migrations for MySQL, +1. You have to ensure that you have the MySQL Server up and running on your development machine. +2. You have a valid connection string to the MySQL Server updated on both the `database.json` and `hangfire.json` configuration files. This also assumes that you have updated `"DBProvider": "mysql"` too. + +Below are some sample configurations for MySQL Provider. The above is applicable to all the other DB Provider. + +#### database.json + +``` +{ + "DatabaseSettings": { + "ConnectionString": "server=localhost;uid=root;pwd=root;database=defaultRootDb;Allow User Variables=True", + "DBProvider": "mysql" + } +} +``` +#### hangfire.json + +``` +... +"Storage": { + "StorageProvider": "mysql", + "ConnectionString": "server=localhost;uid=root;pwd=root;database=defaultRootDb;Allow User Variables=True", +... +``` + +The Provider values for other supported DBs are as follows. +- MSSQL - **mssql** +- PostgreSQL - **postgresql** +- Oracle - **oracle** + +Once your connection strings are all updated in the mentioned configuration files, open up the command terminal on the Host Project's directory and run the following commands. + +As mentioned earlier, since we have 2 Db Contexts defined in our application, we will have seperate commands for each of the available context classes. + +The generic command to add migrations over the **Application Db Context** goes like this, + +``` +dotnet ef migrations add --project .././Migrators/Migrators./ --context ApplicationDbContext -o Migrations/Application +``` + +where +- `` should be replaced by an appropriate name that describes the Migration +- `` should be replaced by your selected Database Provider (`MSSQL`, `MySQL`, `Oracle` or `PostgreSQL`) + +The generic command to add migrations over the **Tenant Db Context** goes like this, + +``` +dotnet ef migrations add --project .././Migrators/Migrators./ --context TenantDbContext -o Migrations/Tenant +``` + +where +- `` should be replaced by an appropriate name that describes the Migration +- `` should be replaced by your selected Database Provider (`MSSQL`, `MySQL`, `Oracle` or `PostgreSQL`) + +Keeping that in mind, here is how you would add Migrations for MySQL. + +1. Ensure that you have updated the connection string and dbProvider properties of both hangfire.json and database.json configuration files. +2. Open up the command terminal on the Host Project's directory. +3. To add migrations related to ApplicationDbContext, run + +```dotnet ef migrations add AddedMenuEntity --project .././Migrators/Migrators.MySQL/ --context ApplicationDbContext -o Migrations/Application``` + +4. To add migrations related to TenantDbContext, run + +```dotnet ef migrations add ModifiedTenantTable --project .././Migrators/Migrators.MySQL/ --context TenantDbContext -o Migrations/Tenant``` + +That's almost it. Once the process is completed you would be able see new Migration cs files that represent your new additions / modifications at the table level added to the respective Migrator project. + +You do not have to do anything extra to apply the migrations to your database. The application does it for you during the startup. Cheers! diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic1.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic1.png new file mode 100644 index 00000000..b1f9c1fa Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic1.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic10.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic10.png new file mode 100644 index 00000000..21d86964 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic10.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic11.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic11.png new file mode 100644 index 00000000..a60035af Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic11.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic12.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic12.png new file mode 100644 index 00000000..4b9fbc08 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic12.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic13.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic13.png new file mode 100644 index 00000000..6879f388 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic13.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic14.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic14.png new file mode 100644 index 00000000..0fcf62b5 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic14.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic15.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic15.png new file mode 100644 index 00000000..0cdb388b Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic15.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic16.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic16.png new file mode 100644 index 00000000..50a9b82b Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic16.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic17.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic17.png new file mode 100644 index 00000000..2ffe763d Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic17.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic18.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic18.png new file mode 100644 index 00000000..19f80ba9 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic18.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic19.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic19.png new file mode 100644 index 00000000..bc14ea3e Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic19.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic2.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic2.png new file mode 100644 index 00000000..7daeef06 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic2.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic20.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic20.png new file mode 100644 index 00000000..6e8bb9c5 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic20.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic21.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic21.png new file mode 100644 index 00000000..2fcfd1f2 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic21.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic22.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic22.png new file mode 100644 index 00000000..82619db6 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic22.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic23.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic23.png new file mode 100644 index 00000000..678d8e53 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic23.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic24.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic24.png new file mode 100644 index 00000000..232084ad Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic24.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic25.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic25.png new file mode 100644 index 00000000..e1bad3df Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic25.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic26.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic26.png new file mode 100644 index 00000000..af87957a Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic26.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic27.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic27.png new file mode 100644 index 00000000..ac60d6e9 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic27.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic28.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic28.png new file mode 100644 index 00000000..222604ee Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic28.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic29.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic29.png new file mode 100644 index 00000000..30500514 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic29.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic3.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic3.png new file mode 100644 index 00000000..de8e80ee Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic3.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic30.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic30.png new file mode 100644 index 00000000..b0785b4a Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic30.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic31.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic31.png new file mode 100644 index 00000000..61ddd237 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic31.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic32.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic32.png new file mode 100644 index 00000000..8672d7a5 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic32.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic33.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic33.png new file mode 100644 index 00000000..7cd218fc Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic33.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic34.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic34.png new file mode 100644 index 00000000..28a50a99 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic34.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic36.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic36.png new file mode 100644 index 00000000..f900cc3f Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic36.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic37.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic37.png new file mode 100644 index 00000000..be7165d8 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic37.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic38.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic38.png new file mode 100644 index 00000000..1b89fdbf Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic38.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic39.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic39.png new file mode 100644 index 00000000..291bf657 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic39.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic4.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic4.png new file mode 100644 index 00000000..53807f20 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic4.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic40.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic40.png new file mode 100644 index 00000000..94742e50 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic40.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic5.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic5.png new file mode 100644 index 00000000..9b438973 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic5.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic6.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic6.png new file mode 100644 index 00000000..e66218d0 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic6.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic7.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic7.png new file mode 100644 index 00000000..882fab8b Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic7.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic8.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic8.png new file mode 100644 index 00000000..f5dac01f Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic8.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic9.png b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic9.png new file mode 100644 index 00000000..0cc555b3 Binary files /dev/null and b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/azuredeployment-pic9.png differ diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/index.md b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/index.md new file mode 100644 index 00000000..356fcb82 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-azure/index.md @@ -0,0 +1,221 @@ +--- +title: "Deploying to Azure AppService" +description: "Deploying fullstackhero's Web API to Azure AppService from Visual Studio" +lead: "Deploying fullstackhero's Web API to Azure AppService from Visual Studio" +date: 2022-05-12T21:30:38+05:30 +lastmod: 2022-05-12T21:30:33+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "deploying-to-azure" + name: "Deploying to Azure AppService" + parent: "tutorials" +weight: 14 +toc: true +--- + +To Get started, Insure you `Signin` in `Visual Studio` `2019` or `2022` with an account registered in `Azure Portal` and having an active `subscription` + +Step 1: Right click Host project as shown on the picture below and click Publish + +{{< img src="azuredeployment-pic1.png" >}} + +Step 2: Select Azure from the Dialog as shown below and click Next + +{{< img src="azuredeployment-pic2.png" >}} + +Step 3: Select Azure App Service (Windows) as shown below and click Next + +{{< img src="azuredeployment-pic3.png" >}} + +Step 4: Click the green Plus(+) button to create an new `App Service Instance`. Notice the `Subscription` name, you must select your active subscription. + +{{< img src="azuredeployment-pic4.png" >}} + +Step 5: Write your `Api` name, this will form part of your application link(url) +Select same `Subscription` name as previously +Click New on `Resource group` to create new resource group. + +{{< img src="azuredeployment-pic5.png" >}} + +Step 6: Write a `Resource group` name, this is a grouping for resource to be created in Azure. I wrote `Mango-RG`, write your own `resource group` name. Click Ok to save it. + +{{< img src="azuredeployment-pic6.png" >}} + +Step 7: Notice Our `Resource group` name appears. Now click New to create a new `Hosting plan` + +{{< img src="azuredeployment-pic7.png" >}} + +Step 8: Give a `Hosting Plan` name, `Location` I kept the default, but you may need to select the closest area to you. Click dropdown on `Size`, select `Free`, this is a free plan, you are welcome to choose any you can afford through your subscription. Click Ok. + +{{< img src="azuredeployment-pic8.png" >}} + +Step 9: Click Create as shown below, at this point your resources will be created in `Azure Portal` + +{{< img src="azuredeployment-pic9.png" >}} + +Step 10: Notice your `Api` Application instance has been created. Now Click finish. + +{{< img src="azuredeployment-pic10.png" >}} + +Step 11: At this point we can see all our resources. +Before we start configuring, do the following +Install these packages in `Host` project, make sure they are of the same `version` as installed in `Infrastructure`. Doing this help avoid errors later. + +* Microsoft.EntityFrameworkCore.SqlServer +* Microsoft.EntityFrameworkCore.Tools + +Now back to publish tab in `Visual Studio`. +Click Configure under Service Dependencies to create `database` resources. + +{{< img src="azuredeployment-pic11.png" >}} + +Step 12: Select `Azure SQL Database` to create database hosted in `Azure`. Click Next + +{{< img src="azuredeployment-pic12.png" >}} + +Step 12: Select the same `subscription` as before. Click the green Plus(+) button to create `database server` and `database` in `Azure`. + +{{< img src="azuredeployment-pic13.png" >}} + +Step 13: Give a `database` name, notice the validation error! A `database server` needs to be first created. Now click the New button to create it. + +{{< img src="azuredeployment-pic14.png" >}} + +Step 14: Give `database server` name, Location (nearest to you), admin `username` (used to access this `database server`) and `password`. Click Ok, to start creating the `server` and `database` in `Azure Portal`. This will take few minutes. NB note down username and password. I usually add them to a notepad. + +{{< img src="azuredeployment-pic15.png" >}} + +Step 15: Notice our `database server` and `database` are created, see within green block. Now select this row and click Next. + +{{< img src="azuredeployment-pic16.png" >}} + +Step 16: Fill in `ConnectionString` key as it in `appsetting.json`, mine is `DefaultConnection`, +`Username` and `Password` create in Step 14. Click the green block to copy the connection and save it on notepad or anywhere you will be able to find it. Click None + +{{< img src="azuredeployment-pic17.png" >}} + +Step 17: Click finish and restore of `NuGet packages` will begin. Make sure `NuGet packages` is checked. + +{{< img src="azuredeployment-pic18.png" >}} + +NB. If you get an error, follow Step 11. The error is caused by package restore for `Host` project, it needs `Microsoft.EntityFrameworkCore.SqlServer` and +`Microsoft.EntityFrameworkCore.Tools` for database migration. The tool tries to install them for you but it only picks versions `6.0.0` which are not the same versions as those installed in `Infrastructure`. Get that? + +You will be taken back to Step 12 but don’t panic, you won’t have to create `database` and `database server` as they are already created. + + +The restore should be successful as shown below. + +{{< img src="azuredeployment-pic19.png" >}} + +Click Close + +NB. Replace the `ConnectionStrings` in both `database.json` and `hangfire.json` with the one you have just created above. This means you’re `Api` will now point to `Azure` database server. + +Step 18: Login Azure Portal to verify all resources we have just created. Notice all our resources are on the list. Nice. Now let go to `Visual Studio` and `deploy` our `Api` + +{{< img src="azuredeployment-pic20.png" >}} + +Step 19: In `Visual Studio`, Click Publish (green block), this mean you are now `deploying` you `Api` to the `Azure` and can be access on the internet using the url on Site as indicated on the picture. + +{{< img src="azuredeployment-pic21.png" >}} + +Publish is successful and the `Api` was automatically launched in a browser + +{{< img src="azuredeployment-pic22.png" >}} + +Deployment error as the `Api` is launched in the browser. + +{{< img src="azuredeployment-pic23.png" >}} + +Step 20: This error is caused by `Azure` blocking all public access to the `database server` via IP address. + +To see this on the Log file that our application generate, do the following +1. Open a new tab in your browser +2. Write your `Api` url and add `.scm` before `azurewebsites.net` +Example: `https://mangoapi-test.scm.azurewebsites.net/` +3. This is a Kudu dashboard that can be used for debuging your deployed applications, in our case we are debugging our `Api` +4. Click on Debug console as indicated by an arrow, select CMD + +{{< img src="azuredeployment-pic24.png" >}} + +5. Click `site` + +{{< img src="azuredeployment-pic25.png" >}} + +6. Click `wwwroot` + +{{< img src="azuredeployment-pic26.png" >}} + +7. Look for `Logs` folder + +{{< img src="azuredeployment-pic27.png" >}} + +8. Click the download icon where the arrow points to, this should open a new browser tab with your `log` file. + +{{< img src="azuredeployment-pic28.png" >}} + +This is what the `log` exception says + +Microsoft.Data.SqlClient.SqlException (0x80131904): Cannot open server `'mangotestdbdbserver'` requested by the login. Client with IP address `'20.****.40.0'` is not allowed to access the server. To enable access, use the Windows Azure Management Portal or run `sp_set_firewall_rule` on the `master database` to create a `firewall rule` for this IP address or address range. + +I now need to grant this `IP address` access to my `database server` in `Azure Portal` + + +9. Go to the `database server` you have created, in my case is `mangotestdbserver` + +{{< img src="azuredeployment-pic30.png" >}} + +Click on `SQL databases` to view your `database`, it will appear in the table, click it. + +{{< img src="azuredeployment-pic31.png" >}} + +10. Click `Set server firewall` within the red block + +{{< img src="azuredeployment-pic32.png" >}} + +11. Click Add a `firewall rule` + +{{< img src="azuredeployment-pic33.png" >}} + +12. On the dialog I add my local `IP address` (suggested by azure) and `IP address` as show from the `log` because I want this `IP address` and my local machine to have access to the `SQL Server` + +{{< img src="azuredeployment-pic34.png" >}} + +Click Save + +Go to `Visual Studio` and Click Publish (Step 19) + +Now the launched browser shows `404`, relax you have done it. + +{{< img src="azuredeployment-pic36.png" >}} + +To view `Api` documentation in `swagger`, append `/swagger/index.html` to the `url` and you should see your `api`. + +See below + +{{< img src="azuredeployment-pic37.png" >}} + +## Testing via Postman + +You are welcome to use any `Api` client you like for testing. + +Add your deployed `Api` `url` like I did below + +{{< img src="azuredeployment-pic38.png" >}} + +Let’s test `get-token` endpoint + +{{< img src="azuredeployment-pic39.png" >}} + +Click Sent + +I get a response back and it includes a token as expected!!!! + +{{< img src="azuredeployment-pic40.png" >}} + +That’s it guys, hope this can help someone. Screenshots are not of the best quality. + +The deployed `Api` can be accessed here `https://mangoapi-test.azurewebsites.net/swagger/index.html` \ No newline at end of file diff --git a/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-iis/index.md b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-iis/index.md new file mode 100644 index 00000000..3aa41718 --- /dev/null +++ b/content/en/dotnet-webapi-boilerplate/tutorials/deploying-to-iis/index.md @@ -0,0 +1,18 @@ +--- +title: "Deploying to IIS" +description: "Deploying fullstackhero's Web API to IIS" +lead: "Deploying fullstackhero's Web API to IIS" +date: 2021-08-30T00:59:34+05:30 +lastmod: 2021-11-29T00:44:06+05:30 +draft: false +images: [] +menu: + dotnet-webapi-boilerplate: + identifier: "deploying-to-iis" + name: "Deploying to IIS" + parent: "tutorials" +weight: 13 +toc: true +--- + +Documentation Coming Soon! diff --git a/content/en/privacy-policy/index.md b/content/en/privacy-policy/index.md new file mode 100644 index 00000000..0ef38e23 --- /dev/null +++ b/content/en/privacy-policy/index.md @@ -0,0 +1,35 @@ +--- +title: "Privacy Policy" +description: "We do not use cookies and we do not collect any personal data." +date: 2020-08-27T19:23:18+02:00 +lastmod: 2020-08-27T19:23:18+02:00 +draft: false +images: [] +--- + +__TLDR__: We do not use cookies and we do not collect any personal data. + +## Website visitors + +- No personal information is collected. +- No information is stored in the browser. +- No information is shared with, sent to or sold to third-parties. +- No information is shared with advertising companies. +- No information is mined and harvested for personal and behavioral trends. +- No information is monetized. + +### Information we collect and what we use it for + +We run [Plausible](https://plausible.io/) analytics on getdoks.org. The following information is collected: + +- __Page URL__. We track the page URL of each page view on this website. We use this to understand which pages have been viewed and how many times a particular page has been viewed. For example: _https://getdoks.org/_. +- __HTTP Referrer__. We use the referrer string to understand the number of visitors referred to this website from links on other sites. For example: _https://github.com/_. +- __Browser__. We use this to understand what browsers people use when visiting this website. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _Chrome_. +- __Operating system__. We use this to understand what operating systems people use when visiting this website. We only use the brand of the operating system and don’t include the version number or any other details. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _GNU/Linux_. +- __Device type__. We use this to understand what devices people use when visiting this website. This is derived from window.innerWidth. The actual width of the browser in pixels is discarded. For example: _Desktop_. +- __Visitor Country__. We look up the visitor’s country using the IP address. We do not track anything more granular than the country of origin and the IP address of the visitor is discarded. We never store IP addresses in our database or logs. For example: _Canada_. + +## Contact us + + +Effective Date: _27th August 2020_ diff --git a/content/en/versions.md b/content/en/versions.md new file mode 100644 index 00000000..ddbe0020 --- /dev/null +++ b/content/en/versions.md @@ -0,0 +1,11 @@ +--- +title: "Versions" +description: "" +lead: "An appendix of hosted documentation for nearly every release of Doks, from v0 through v3." +date: 2021-09-24T08:50:23+02:00 +lastmod: 2021-09-24T08:50:23+02:00 +draft: true +images: [] +layout: versions +url: "/docs/versions/" +--- diff --git a/content/getting-started/_index.md b/content/getting-started/_index.md deleted file mode 100644 index 82a566a6..00000000 --- a/content/getting-started/_index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title : "fullstackhero - What's it?" -description: "fullstackhero is a collection of Enterprise Level Boilerplates for Modern Web Applications that gets you started with premium application development in no-time!" -lead: "" -date: 2021-08-24T11:40:05+05:30 -lastmod: 2021-08-24T12:44:46+05:30 -draft: false -images: [] ---- - -## Benefits of fullstackhero - -* Given that fullstackhero is a collection of open source projects, it's completely free to use and distribute. - - -## Projects - -### .NET WebAPI - -[Read Documentation →](/dotnet-webapi-boilerplate/) - -### Angular Material - -### .NET MVC - -### Blazor WebAssembly - - -## Contact - -[Contact me]({{< relref "contact/index.md" >}}) if you have any questions. diff --git a/content/getting-started/angular.svg b/content/getting-started/angular.svg deleted file mode 100644 index ac4992b0..00000000 --- a/content/getting-started/angular.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/content/nl/_index.md b/content/nl/_index.md new file mode 100644 index 00000000..58c6b69f --- /dev/null +++ b/content/nl/_index.md @@ -0,0 +1,10 @@ +--- +title : "Modern documentatie-thema" +description: "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard." +lead: "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard." +date: 2020-10-06T08:47:36+00:00 +lastmod: 2020-10-06T08:47:36+00:00 +draft: false +images: [] +--- + diff --git a/content/nl/contact/index.md b/content/nl/contact/index.md new file mode 100644 index 00000000..795089f6 --- /dev/null +++ b/content/nl/contact/index.md @@ -0,0 +1,10 @@ +--- +title: "Contact" +description: "Drop us an email." +date: 2020-08-27T19:25:12+02:00 +lastmod: 2020-08-27T19:25:12+02:00 +draft: true +images: [] +--- + +{{< email user="hello" domain="getdoks.org" >}} diff --git a/content/nl/contributors/_index.md b/content/nl/contributors/_index.md new file mode 100644 index 00000000..e225f344 --- /dev/null +++ b/content/nl/contributors/_index.md @@ -0,0 +1,10 @@ +--- +title: "Contributors" +description: "The Doks contributors." +date: 2020-10-06T08:50:29+00:00 +lastmod: 2020-10-06T08:50:29+00:00 +draft: false +images: [] +--- + +The Doks contributors. diff --git a/content/nl/contributors/henk-verlinde/_index.md b/content/nl/contributors/henk-verlinde/_index.md new file mode 100644 index 00000000..f775534e --- /dev/null +++ b/content/nl/contributors/henk-verlinde/_index.md @@ -0,0 +1,12 @@ +--- +title: "Henk Verlinde" +description: "Creator of Hyas." +date: 2020-10-06T08:50:45+00:00 +lastmod: 2020-10-06T08:50:45+00:00 +draft: false +images: [] +--- + +Creator of Hyas. + +[@HenkVerlinde](https://twitter.com/henkverlinde) diff --git a/content/nl/docs/_index.md b/content/nl/docs/_index.md new file mode 100644 index 00000000..f807c652 --- /dev/null +++ b/content/nl/docs/_index.md @@ -0,0 +1,9 @@ +--- +title : "Docs" +description: "Docs Doks." +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +--- diff --git a/content/nl/docs/help/_index.md b/content/nl/docs/help/_index.md new file mode 100644 index 00000000..bc503ecf --- /dev/null +++ b/content/nl/docs/help/_index.md @@ -0,0 +1,9 @@ +--- +title: "Help" +description: "Help Doks." +lead: "" +date: 2020-10-06T08:49:15+00:00 +lastmod: 2020-10-06T08:49:15+00:00 +draft: false +images: [] +--- diff --git a/content/nl/docs/help/faq.md b/content/nl/docs/help/faq.md new file mode 100644 index 00000000..f0c3bb4d --- /dev/null +++ b/content/nl/docs/help/faq.md @@ -0,0 +1,50 @@ +--- +title: "FAQ" +description: "Answers to frequently asked questions." +lead: "Answers to frequently asked questions." +date: 2020-10-06T08:49:31+00:00 +lastmod: 2020-10-06T08:49:31+00:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 630 +toc: true +--- + +## Hyas? + +Doks is a [Hyas theme](https://gethyas.com/themes/) build by the creator of Hyas. + +## Footer notice? + +Please keep it in place. + +## Keyboard shortcuts for search? + +- focus: `Ctrl + /` +- select: `↓` and `↑` +- open: `Enter` +- close: `Esc` + +## Other documentation? + +- [Netlify](https://docs.netlify.com/) +- [Hugo](https://gohugo.io/documentation/) + +## Can I get support? + +Create a topic: + +- [Netlify Community](https://community.netlify.com/) +- [Hugo Forums](https://discourse.gohugo.io/) +- [Doks Discussions](https://github.com/h-enk/doks/discussions) + +## Contact the creator? + +Send `h-enk` a message: + +- [Netlify Community](https://community.netlify.com/) +- [Hugo Forums](https://discourse.gohugo.io/) +- [Doks Discussions](https://github.com/h-enk/doks/discussions) diff --git a/content/nl/docs/help/how-to-update.md b/content/nl/docs/help/how-to-update.md new file mode 100644 index 00000000..f9bb36b9 --- /dev/null +++ b/content/nl/docs/help/how-to-update.md @@ -0,0 +1,32 @@ +--- +title: "How to Update" +description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." +lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." +date: 2020-11-12T13:26:54+01:00 +lastmod: 2020-11-12T13:26:54+01:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 610 +toc: true +--- + +{{< alert icon="💡" text="Learn more about semantic versioning and advanced range syntax." />}} + +## Check for outdated packages + +The [`npm outdated`](https://docs.npmjs.com/cli/v7/commands/npm-outdated) command will check the registry to see if any (or, specific) installed packages are currently outdated: + +```bash +npm outdated [[<@scope>/] ...] +``` + +## Update packages + +The [`npm update`](https://docs.npmjs.com/cli/v7/commands/npm-update) command will update all the packages listed to the latest version (specified by the tag config), respecting semver: + +```bash +npm update [...] +``` diff --git a/content/nl/docs/help/troubleshooting.md b/content/nl/docs/help/troubleshooting.md new file mode 100644 index 00000000..0d52dbb1 --- /dev/null +++ b/content/nl/docs/help/troubleshooting.md @@ -0,0 +1,30 @@ +--- +title: "Troubleshooting" +description: "Solutions to common problems." +lead: "Solutions to common problems." +date: 2020-11-12T15:22:20+01:00 +lastmod: 2020-11-12T15:22:20+01:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 620 +toc: true +--- + +## Problems updating npm packages + +Delete the `./node_modules` folder, and run again: + +```bash +npm install +``` + +## Problems with cache + +Delete the temporary directories: + +```bash +npm run clean +``` diff --git a/content/nl/docs/prologue/_index.md b/content/nl/docs/prologue/_index.md new file mode 100644 index 00000000..c3c1c40b --- /dev/null +++ b/content/nl/docs/prologue/_index.md @@ -0,0 +1,9 @@ +--- +title : "Prologue" +description: "Prologue Doks." +lead: "" +date: 2020-10-06T08:48:45+00:00 +lastmod: 2020-10-06T08:48:45+00:00 +draft: false +images: [] +--- diff --git a/content/nl/docs/prologue/commands.md b/content/nl/docs/prologue/commands.md new file mode 100644 index 00000000..e647a98e --- /dev/null +++ b/content/nl/docs/prologue/commands.md @@ -0,0 +1,98 @@ +--- +title: "Commands" +description: "Doks comes with commands for common tasks." +lead: "Doks comes with commands for common tasks." +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 130 +toc: true +--- + +{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." />}} + +## create + +Create new content for your site: + +```bash +npm run create [path] [flags] +``` + +See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/). + +## lint + +Check scripts, styles, and markdown for errors: + +```bash +npm run lint +``` + +### scripts + +Check scripts for errors: + +```bash +npm run lint:scripts [-- --fix] +``` + +### styles + +Check styles for errors: + +```bash +npm run lint:styles [-- --fix] +``` + +### markdown + +Check markdown for errors: + +```bash +npm run lint:markdown [-- --fix] +``` + +## clean + +Delete temporary directories: + +```bash +npm run clean +``` + +## start + +Start local development server: + +```bash +npm run start +``` + +## build + +Build production website: + +```bash +npm run build +``` + +### functions + +Build Lambda functions: + +```bash +npm run build:functions +``` + +### preview + +Build production website including draft and future content: + +```bash +npm run build:preview +``` diff --git a/content/nl/docs/prologue/introduction.md b/content/nl/docs/prologue/introduction.md new file mode 100644 index 00000000..f2155338 --- /dev/null +++ b/content/nl/docs/prologue/introduction.md @@ -0,0 +1,58 @@ +--- +title: "Introduction" +description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +date: 2020-10-06T08:48:57+00:00 +lastmod: 2020-10-06T08:48:57+00:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 100 +toc: true +--- + +## Get started + +There are two main ways to get started with Doks: + +### Tutorial + +{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." />}} + +Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/) + +### Quick Start + +{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." />}} + +One page summary of how to start a new Doks project. [Quick Start →]({{< relref "quick-start" >}}) + +## Go further + +Recipes, Reference Guides, Extensions, and Showcase. + +### Recipes + +Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/) + +### Reference Guides + +Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/) + +### Extensions + +Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/) + +### Showcase + +See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/) + +## Contributing + +Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/) + +## Help + +Get help on Doks. [Help →]({{< relref "how-to-update" >}}) diff --git a/content/nl/docs/prologue/quick-start.md b/content/nl/docs/prologue/quick-start.md new file mode 100644 index 00000000..9282d3ee --- /dev/null +++ b/content/nl/docs/prologue/quick-start.md @@ -0,0 +1,69 @@ +--- +title: "Quick Start" +description: "One page summary of how to start a new Doks project." +lead: "One page summary of how to start a new Doks project." +date: 2020-11-16T13:59:39+01:00 +lastmod: 2020-11-16T13:59:39+01:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 110 +toc: true +--- + +## Requirements + +Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts: + +- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform. + +## Start a new Doks project + +Create a new site, change directories, install dependencies, and start development server. + +### Create a new site + +Doks is available as a child theme, and a starter theme: + +- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates. +- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates. + +Not quite sure? Use the Doks child theme. + +#### Doks child theme + +```bash +git clone https://github.com/h-enk/doks-child-theme.git my-doks-site +``` + +#### Doks starter theme + +```bash +git clone https://github.com/h-enk/doks.git my-doks-site +``` + +### Change directories + +```bash +cd my-doks-site +``` + +### Install dependencies + +```bash +npm install +``` + +### Start development server + +```bash +npm run start +``` + +Doks will start the Hugo development webserver accessible by default at `http://localhost:1313`. Saved changes will live reload in the browser. + +## Other commands + +Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}}) diff --git a/content/privacy-policy/index.md b/content/nl/privacy-policy/index.md similarity index 96% rename from content/privacy-policy/index.md rename to content/nl/privacy-policy/index.md index 9b0a01d5..63150240 100644 --- a/content/privacy-policy/index.md +++ b/content/nl/privacy-policy/index.md @@ -1,9 +1,9 @@ --- title: "Privacy Policy" description: "We do not use cookies and we do not collect any personal data." -date: 2021-08-24T11:40:05+05:30 -lastmod: 2021-08-24T11:40:16+05:30 -draft: false +date: 2020-08-27T19:23:18+02:00 +lastmod: 2020-08-27T19:23:18+02:00 +draft: true images: [] --- diff --git a/data/docs-versions.yml b/data/docs-versions.yml new file mode 100644 index 00000000..8e7e5dd9 --- /dev/null +++ b/data/docs-versions.yml @@ -0,0 +1,60 @@ +# - group: v1.x +# baseurl: "https://getbootstrap.com" +# description: "Every minor and patch release from v1 is listed below." +# versions: +# - v: "1.0.0" +# - v: "1.1.0" +# - v: "1.1.1" +# - v: "1.2.0" +# - v: "1.3.0" +# - v: "1.4.0" +# +# - group: v2.x +# baseurl: "https://getbootstrap.com" +# description: "Every minor and patch release from v2 is listed below." +# versions: +# - v: "2.0.0" +# - v: "2.0.1" +# - v: "2.0.2" +# - v: "2.0.3" +# - v: "2.0.4" +# - v: "2.1.0" +# - v: "2.1.1" +# - v: "2.2.0" +# - v: "2.2.1" +# - v: "2.2.2" +# - v: "2.3.0" +# - v: "2.3.1" +# - v: "2.3.2" +# +# - group: v3.x +# baseurl: "https://getbootstrap.com/docs" +# description: "Every minor and patch release from v3 is listed below. Last update was v3.4.1." +# versions: +# - v: "3.3" +# - v: "3.4" +# +# - group: v4.x +# baseurl: "https://getbootstrap.com/docs" +# description: "Our previous major release with its minor releases. Last update was v4.6.0." +# versions: +# - v: "4.0" +# - v: "4.1" +# - v: "4.2" +# - v: "4.3" +# - v: "4.4" +# - v: "4.5" +# - v: "4.6" + +- group: v0.x + baseurl: "/docs" + description: "Current major release. Last update was v0.2.0." + versions: + - v: "0.1" + - v: "0.2" + +- group: v1.x + baseurl: "/docs" + description: "Every minor and patch release from v1 is listed below. Last update was v1.0.0." + versions: + - v: "1.0" diff --git a/i18n/en.toml b/i18n/en.toml new file mode 100644 index 00000000..cb52685f --- /dev/null +++ b/i18n/en.toml @@ -0,0 +1,2 @@ +[get-started] + other = "Get Started" \ No newline at end of file diff --git a/i18n/nl.toml b/i18n/nl.toml new file mode 100644 index 00000000..f80323ee --- /dev/null +++ b/i18n/nl.toml @@ -0,0 +1,2 @@ +[get-started] + other = "Aan de slag" \ No newline at end of file diff --git a/images/screenshot.png b/images/screenshot.png index acbfb55e..072753bb 100644 Binary files a/images/screenshot.png and b/images/screenshot.png differ diff --git a/images/tn.png b/images/tn.png index fecf5c5b..ff29c682 100644 Binary files a/images/tn.png and b/images/tn.png differ diff --git a/layouts/_default/_markup/.gitkeep b/layouts/_default/_markup/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/layouts/_default/_markup/render-heading.html b/layouts/_default/_markup/render-heading.html new file mode 100644 index 00000000..8abeac6c --- /dev/null +++ b/layouts/_default/_markup/render-heading.html @@ -0,0 +1 @@ +{{ .Text | safeHTML }} diff --git a/layouts/_default/_markup/render-image.html b/layouts/_default/_markup/render-image.html new file mode 100644 index 00000000..4a44740e --- /dev/null +++ b/layouts/_default/_markup/render-image.html @@ -0,0 +1,36 @@ +{{ $image := "" -}} +{{ if (urls.Parse .Destination).IsAbs }} + {{ $image = resources.GetRemote .Destination -}} +{{ else -}} + {{ $image = .Page.Resources.GetMatch .Destination -}} +{{ end -}} +{{ with $image -}} + {{ $lqip := $image.Resize site.Params.lqipWidth -}} + + {{ $imgSrc := "" -}} + {{ $imgSrcSet := slice -}} + + {{ $widths := site.Params.landscapePhotoWidths -}} + {{ if gt $image.Height $image.Width -}} + {{ $widths = site.Params.portraitPhotoWidths -}} + {{ end -}} + + {{ range $widths -}} + {{ $srcUrl := (printf "%dx" . | $image.Resize).Permalink -}} + {{ if eq $imgSrc "" -}}{{ $imgSrc = $srcUrl -}}{{ end -}} + {{ $imgSrcSet = $imgSrcSet | append (printf "%s %dw" $srcUrl .) -}} + {{ end -}} + {{ $imgSrcSet = (delimit $imgSrcSet ",") -}} + + {{ if gt $image.Width site.Params.smallLimit -}} +
+ {{ $.Text }} + + {{ with $.Title }}
{{ . | safeHTML }}
{{ end -}} +
+ {{ else -}} + {{ $.Text }} + {{ end -}} +{{ else -}} + {{ erroridf "image-not-found" "Image not found" -}} +{{ end -}} \ No newline at end of file diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index cd81b7c6..21113b64 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -1,36 +1,30 @@ - -{{ partial "head/head.html" . }} -{{ if eq .Kind "home" -}} -{{ .Scratch.Set "class" "home" -}} -{{ else if eq .Kind "404" -}} -{{ .Scratch.Set "class" "error404" -}} -{{ else if eq .Kind "page" -}} -{{ .Scratch.Set "class" .Type -}} -{{ .Scratch.Add "class" " single" -}} -{{ else -}} -{{ .Scratch.Set "class" .Type -}} -{{ .Scratch.Add "class" " list" -}} -{{ end -}} - - - {{ partial "header/header.html" . }} -
-
- {{ block "main" . }}{{ end }} + + {{ partial "head/head.html" . }} + {{ if eq .Kind "home" -}} + {{ .Scratch.Set "class" "home" -}} + {{ else if eq .Kind "404" -}} + {{ .Scratch.Set "class" "error404" -}} + {{ else if eq .Kind "page" -}} + {{ .Scratch.Set "class" .Type -}} + {{ .Scratch.Add "class" " single" -}} + {{ else -}} + {{ .Scratch.Set "class" .Type -}} + {{ .Scratch.Add "class" " list" -}} + {{ end -}} + + {{ partial "header/header.html" . }} +
+
+ {{ block "main" . }}{{ end }} +
-
- {{ block "sidebar-prefooter" . }}{{ end }} - {{ block "sidebar-footer" . }}{{ end }} - {{ partial "footer/footer.html" . }} - {{ if and .IsHome .Site.Params.alert }} - {{ partial "footer/alert.html" . }} - {{ end }} - {{ partial "footer/script-footer.html" . }} - - - - + diff --git a/layouts/_default/index.js b/layouts/_default/index.js index 88ecb6b6..9f764f91 100644 --- a/layouts/_default/index.js +++ b/layouts/_default/index.js @@ -1,11 +1,10 @@ var docs = [ - {{ range $index, $page := (where site.RegularPages "Type" "in" site.Params.mainSections) -}} - { - id: {{ $index }}, - href: "{{ .RelPermalink | relURL }}", - title: {{ .Title | jsonify }}, - description: {{ .Params.description | jsonify }}, - content: {{ .Content | jsonify }} - }, - {{ end -}} -]; +{{ range $index, $page := (where .Site.Pages "Section" "docs") -}} + { + id: {{ $index }}, + title: "{{ .Title }}", + description: "{{ .Params.description }}", + href: "{{ .URL | relURL }}" + }, +{{ end -}} +]; \ No newline at end of file diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 4c1eab4f..17a6b20c 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -1,8 +1,9 @@ {{ define "main" }} -
+

{{ .Title }}

+ {{ partial "main/view-counter.html" . }} {{ .Content }}
diff --git a/layouts/_default/versions.html b/layouts/_default/versions.html new file mode 100644 index 00000000..3101b825 --- /dev/null +++ b/layouts/_default/versions.html @@ -0,0 +1,27 @@ +{{ define "main" }} +
+

{{ .Title }}

+

{{ .Params.lead | safeHTML }}

+ {{ .Content }} +
+ {{ range $release := sort (index $.Site.Data "docs-versions") "group" "desc" -}} +
+

{{ $release.group }}

+

{{ $release.description }}

+ {{ $versions := sort $release.versions "v" "desc" -}} + {{ range $i, $version := $versions -}} + {{ $len := len $versions -}} + {{ if (eq $i 0) }}
{{ end }} + + {{ $version.v }} + {{ if (eq $version.v $.Site.Params.docsVersion) -}} + Latest + {{ end -}} + + {{ if (eq (add $i 1) $len) }}
{{ end }} + {{ end -}} +
+ {{ end -}} +
+
+{{ end }} diff --git a/layouts/basics/list.html b/layouts/basics/list.html new file mode 100644 index 00000000..864c6b49 --- /dev/null +++ b/layouts/basics/list.html @@ -0,0 +1,39 @@ +{{ define "main" }} +
+
+ +
+ {{ if ne .Params.toc false -}} + + {{ end -}} +
+
+

{{ if eq .CurrentSection .FirstSection }}{{ .Name }}{{ else }}{{ .Title }}{{ end }}

+
{{ .Description }}
+
{{ .Content }}
+
+ {{ $currentSection := .CurrentSection }} + {{ range where .Site.RegularPages.ByTitle "Section" .Section }} + {{ if in (.RelPermalink | string) $currentSection.RelPermalink }} +
+
+ +

{{ .Params.title | title }}

+

{{ .Params.description | title }}

+ +
+
+ {{ end }} + {{ end }} +
+
+ {{ partial "main/docs-navigation.html" . }} +
+ +
+ +{{ end }} diff --git a/layouts/basics/single.html b/layouts/basics/single.html new file mode 100644 index 00000000..65ffd0c3 --- /dev/null +++ b/layouts/basics/single.html @@ -0,0 +1,54 @@ +{{ define "main" }} +
+
+ +
+ {{ if ne .Params.toc false -}} + + {{ end -}} + {{ if .Params.toc -}} +
+ {{ else -}} +
+ {{ end -}} + {{ if .Site.Params.options.breadCrumb -}} + + + {{ end }} +

{{ .Title }}

+ {{ partial "main/view-counter.html" . }} +

{{ .Params.lead | safeHTML }}

+ {{ if ne .Params.toc false -}} + + {{ end -}} + {{ .Content }} +
+ {{ if .Site.Params.lastMod -}} + {{ partial "main/last-modified.html" . }} + {{ end -}} + {{ if .Site.Params.editPage -}} + {{ partial "main/edit-page.html" . }} + {{ end -}} +
+ {{ partial "main/docs-navigation.html" . }} + +
+
+{{ end }} diff --git a/layouts/blazor-webassembly-boilerplate/list.html b/layouts/blazor-webassembly-boilerplate/list.html new file mode 100644 index 00000000..864c6b49 --- /dev/null +++ b/layouts/blazor-webassembly-boilerplate/list.html @@ -0,0 +1,39 @@ +{{ define "main" }} +
+
+ +
+ {{ if ne .Params.toc false -}} + + {{ end -}} +
+
+

{{ if eq .CurrentSection .FirstSection }}{{ .Name }}{{ else }}{{ .Title }}{{ end }}

+
{{ .Description }}
+
{{ .Content }}
+
+ {{ $currentSection := .CurrentSection }} + {{ range where .Site.RegularPages.ByTitle "Section" .Section }} + {{ if in (.RelPermalink | string) $currentSection.RelPermalink }} +
+
+ +

{{ .Params.title | title }}

+

{{ .Params.description | title }}

+ +
+
+ {{ end }} + {{ end }} +
+
+ {{ partial "main/docs-navigation.html" . }} +
+ +
+ +{{ end }} diff --git a/layouts/blazor-webassembly-boilerplate/single.html b/layouts/blazor-webassembly-boilerplate/single.html new file mode 100644 index 00000000..6c12ce78 --- /dev/null +++ b/layouts/blazor-webassembly-boilerplate/single.html @@ -0,0 +1,59 @@ +{{ define "main" }} +
+
+ +
+ {{ if ne .Params.toc false -}} + + {{ end -}} + {{ if .Params.toc -}} +
+ {{ else -}} +
+ {{ end -}} + {{ if .Site.Params.options.breadCrumb -}} + + + {{ end }} +

{{ .Title }}

+ {{ partial "main/view-counter.html" . }} + + + +

+

{{ .Params.lead | safeHTML }}

+ {{ if ne .Params.toc false -}} + + {{ end -}} + {{ .Content }} +
+ {{ if .Site.Params.lastMod -}} + {{ partial "main/last-modified.html" . }} + {{ end -}} + {{ if .Site.Params.editPage -}} + {{ partial "main/edit-page.html" . }} + {{ end -}} +
+ {{ partial "main/docs-navigation.html" . }} + +
+
+{{ end }} diff --git a/layouts/blog/list.html b/layouts/blog/list.html index a268ca59..9695387c 100644 --- a/layouts/blog/list.html +++ b/layouts/blog/list.html @@ -5,7 +5,8 @@

{{ .Title }}

{{ .Content }}
- {{ range .Data.Pages -}} + {{ $paginator := .Paginate (.Data.Pages) -}} + {{ range $paginator.Pages -}}

{{ .Params.title }}

@@ -14,6 +15,8 @@

{{

{{ end -}} + {{ $.Scratch.Set "paginator" true }} + {{ template "_internal/pagination.html" . }}
diff --git a/layouts/blog/single.html b/layouts/blog/single.html index f611cbda..48fdb82a 100644 --- a/layouts/blog/single.html +++ b/layouts/blog/single.html @@ -1,6 +1,6 @@ {{ define "main" }} -
-
+
+

{{ .Title }}

@@ -9,15 +9,6 @@

{{ .Title }}

{{ .Params.lead | safeHTML }}

{{ .Content }}
-
-

Like fullstackhero?

-

Support the project by buying me a coffee!

- - Buy me - a Coffee -
- -{{ end }} +{{ end }} \ No newline at end of file diff --git a/layouts/docs/list.html b/layouts/docs/list.html index 87964863..ea3ed6df 100644 --- a/layouts/docs/list.html +++ b/layouts/docs/list.html @@ -1,43 +1,22 @@ {{ define "main" }} -
-
- +
+
+
+

{{ if eq .CurrentSection .FirstSection }}{{ .Section | humanize }}{{ else }}{{ .Title }}{{ end }}

+
{{ .Content }}
+
+ {{ $currentSection := .CurrentSection }} + {{ range where .Site.RegularPages.ByTitle "Section" .Section }} + {{ if in (.RelPermalink | string) $currentSection.RelPermalink }} +
+
+ {{ .Params.title | title }} → +
+
+ {{ end }} + {{ end }} +
+
- {{ if ne .Params.toc false -}} - - {{ end -}} - {{ if .Params.toc -}} -
- {{ else -}} -
- {{ end -}} -

{{ .Title }}

-
{{ .Description }}
-

{{ .Params.lead | safeHTML }}

- {{ partial "main/headline-hash.html" .Content }} -
- {{ $currentSection := .CurrentSection }} - {{ range where .Site.RegularPages "Section" .Section }} - {{ if in (.RelPermalink | string) $currentSection.RelPermalink }} -
-
- -

{{ .Params.title | title }}

-

{{ .Params.description | title }}

- -
-
- {{ end }} - {{ end }} -
- {{ if .Site.Params.editPage -}} - {{ partial "main/edit-page.html" . }} - {{ end -}} - {{ partial "main/docs-navigation.html" . }} -
{{ end }} diff --git a/layouts/docs/single.html b/layouts/docs/single.html index 5b1a1bbf..1746d0a8 100644 --- a/layouts/docs/single.html +++ b/layouts/docs/single.html @@ -1,6 +1,6 @@ {{ define "main" }}
-
+
@@ -11,9 +11,9 @@ {{ end -}} {{ if .Params.toc -}} -
+
{{ else -}} -
+
{{ end -}} {{ if .Site.Params.options.breadCrumb -}} @@ -26,15 +26,28 @@ {{ end }}

{{ .Title }}

{{ .Params.lead | safeHTML }}

- {{ partial "main/headline-hash.html" .Content }} - {{ if .Site.Params.editPage -}} - {{ partial "main/edit-page.html" . }} + {{ if ne .Params.toc false -}} + {{ end -}} + {{ .Content }} +
+ {{ if .Site.Params.lastMod -}} + {{ partial "main/last-modified.html" . }} + {{ end -}} + {{ if .Site.Params.editPage -}} + {{ partial "main/edit-page.html" . }} + {{ end -}} +
+ {{ partial "main/docs-navigation.html" . }} +
{{ end }} diff --git a/layouts/dotnet-microservices-boilerplate/list.html b/layouts/dotnet-microservices-boilerplate/list.html new file mode 100644 index 00000000..864c6b49 --- /dev/null +++ b/layouts/dotnet-microservices-boilerplate/list.html @@ -0,0 +1,39 @@ +{{ define "main" }} +
+
+ +
+ {{ if ne .Params.toc false -}} + + {{ end -}} +
+
+

{{ if eq .CurrentSection .FirstSection }}{{ .Name }}{{ else }}{{ .Title }}{{ end }}

+
{{ .Description }}
+
{{ .Content }}
+
+ {{ $currentSection := .CurrentSection }} + {{ range where .Site.RegularPages.ByTitle "Section" .Section }} + {{ if in (.RelPermalink | string) $currentSection.RelPermalink }} +
+
+ +

{{ .Params.title | title }}

+

{{ .Params.description | title }}

+ +
+
+ {{ end }} + {{ end }} +
+
+ {{ partial "main/docs-navigation.html" . }} +
+ +
+ +{{ end }} diff --git a/layouts/dotnet-microservices-boilerplate/single.html b/layouts/dotnet-microservices-boilerplate/single.html new file mode 100644 index 00000000..4115379f --- /dev/null +++ b/layouts/dotnet-microservices-boilerplate/single.html @@ -0,0 +1,59 @@ +{{ define "main" }} +
+
+ +
+ {{ if ne .Params.toc false -}} + + {{ end -}} + {{ if .Params.toc -}} +
+ {{ else -}} +
+ {{ end -}} + {{ if .Site.Params.options.breadCrumb -}} + + + {{ end }} +

{{ .Title }}

+ {{ partial "main/view-counter.html" . }} + + + +

+

{{ .Params.lead | safeHTML }}

+ {{ if ne .Params.toc false -}} + + {{ end -}} + {{ .Content }} +
+ {{ if .Site.Params.lastMod -}} + {{ partial "main/last-modified.html" . }} + {{ end -}} + {{ if .Site.Params.editPage -}} + {{ partial "main/edit-page.html" . }} + {{ end -}} +
+ {{ partial "main/docs-navigation.html" . }} + +
+
+{{ end }} diff --git a/layouts/dotnet-webapi-boilerplate/list.html b/layouts/dotnet-webapi-boilerplate/list.html index 8a82ab44..864c6b49 100644 --- a/layouts/dotnet-webapi-boilerplate/list.html +++ b/layouts/dotnet-webapi-boilerplate/list.html @@ -1,8 +1,8 @@ {{ define "main" }}
-
+
{{ if ne .Params.toc false -}} @@ -10,39 +10,30 @@ {{ partial "sidebar/docs-toc.html" . }} {{ end -}} - {{ if .Params.toc -}} -
- {{ else -}} -
- {{ end -}} - {{ if .Site.Params.options.breadCrumb -}} - - {{ end }} -

{{ .Title }}

+
+
+

{{ if eq .CurrentSection .FirstSection }}{{ .Name }}{{ else }}{{ .Title }}{{ end }}

{{ .Description }}
-

{{ .Params.lead | safeHTML }}

- {{ partial "main/headline-hash.html" .Content }} -
- {{ $currentSection := .CurrentSection }} - {{ range where .Site.RegularPages "Section" .Section }} - {{ if in (.RelPermalink | string) $currentSection.RelPermalink }} -
-
- -

{{ .Params.title | title }}

-

{{ .Params.description | title }}

- -
-
- {{ end }} - {{ end }} -
- {{ partial "main/docs-navigation.html" . }} -
+
{{ .Content }}
+
+ {{ $currentSection := .CurrentSection }} + {{ range where .Site.RegularPages.ByTitle "Section" .Section }} + {{ if in (.RelPermalink | string) $currentSection.RelPermalink }} +
+
+ +

{{ .Params.title | title }}

+

{{ .Params.description | title }}

+ +
+
+ {{ end }} + {{ end }} +
+ + {{ partial "main/docs-navigation.html" . }} +
+
+ {{ end }} diff --git a/layouts/dotnet-webapi-boilerplate/single.html b/layouts/dotnet-webapi-boilerplate/single.html index c11ea9fd..4115379f 100644 --- a/layouts/dotnet-webapi-boilerplate/single.html +++ b/layouts/dotnet-webapi-boilerplate/single.html @@ -1,43 +1,59 @@ {{ define "main" }} -
-
- -
- {{ if ne .Params.toc false -}} - - {{ end -}} - {{ if .Params.toc -}} -
- {{ else -}} -
- {{ end -}} - {{ if .Site.Params.options.breadCrumb -}} - - - {{ end }} -

{{ .Title }}

-
Last Updated On {{ .Lastmod.Format "January 02, 2006" }} 😎
+
+
+ +
+ {{ if ne .Params.toc false -}} + + {{ end -}} + {{ if .Params.toc -}} +
+ {{ else -}} +
+ {{ end -}} + {{ if .Site.Params.options.breadCrumb -}} + + + {{ end }} +

{{ .Title }}

{{ partial "main/view-counter.html" . }} -

{{ .Params.lead | safeHTML }}

- {{ partial "main/headline-hash.html" .Content }} - {{ if .Site.Params.editPage -}} -

Want to add in More Details or Update this Document ?

- {{ partial "main/edit-page.html" . }} - {{ end -}} - {{ if not .Site.Params.options.collapsibleSidebar -}} - {{ partial "main/docs-navigation.html" . }} - {{ else -}} -
- {{ end -}} -
-
+ + + +

+

{{ .Params.lead | safeHTML }}

+ {{ if ne .Params.toc false -}} + + {{ end -}} + {{ .Content }} +
+ {{ if .Site.Params.lastMod -}} + {{ partial "main/last-modified.html" . }} + {{ end -}} + {{ if .Site.Params.editPage -}} + {{ partial "main/edit-page.html" . }} + {{ end -}} +
+ {{ partial "main/docs-navigation.html" . }} + +
+
{{ end }} diff --git a/layouts/getting-started/list.html b/layouts/getting-started/list.html deleted file mode 100644 index fe845a53..00000000 --- a/layouts/getting-started/list.html +++ /dev/null @@ -1,46 +0,0 @@ -{{ define "main" }} -
- {{ if ne .Params.toc false -}} - - {{ end -}} - {{ if .Params.toc -}} -
- {{ else -}} -
- {{ end -}} - {{ if .Site.Params.options.breadCrumb -}} - - {{ end }} -

{{ .Title }}

-
{{ .Description }}
-

{{ .Params.lead | safeHTML }}

- {{ partial "main/headline-hash.html" .Content }} -
- {{ $currentSection := .CurrentSection }} - {{ range where .Site.RegularPages "Section" .Section }} - {{ if in (.RelPermalink | string) $currentSection.RelPermalink }} -
-
- -

{{ .Params.title | title }}

-

{{ .Params.description | title }}

- -
-
- {{ end }} - {{ end }} -
- {{ if .Site.Params.editPage -}} - {{ partial "main/edit-page.html" . }} - {{ end -}} - {{ partial "main/docs-navigation.html" . }} -
-
-{{ end }} diff --git a/layouts/getting-started/single.html b/layouts/getting-started/single.html deleted file mode 100644 index bf5de41e..00000000 --- a/layouts/getting-started/single.html +++ /dev/null @@ -1,29 +0,0 @@ -{{ define "main" }} -
- {{ if ne .Params.toc false -}} - - {{ end -}} - {{ if .Params.toc -}} -
- {{ else -}} -
- {{ end -}} - {{ if .Site.Params.options.breadCrumb -}} - - - {{ end }} -

{{ .Title }}

-

{{ .Params.lead | safeHTML }}

- {{ partial "main/headline-hash.html" .Content }} -
- {{ end -}} -
-
-{{ end }} \ No newline at end of file diff --git a/layouts/index.headers b/layouts/index.headers index ce35f41a..f1be3fb0 100644 --- a/layouts/index.headers +++ b/layouts/index.headers @@ -2,8 +2,9 @@ Strict-Transport-Security: max-age=31536000; includeSubDomains; preload X-Content-Type-Options: nosniff X-XSS-Protection: 1; mode=block - Content-Security-Policy: default-src 'self'; frame-ancestors https://jamstackthemes.dev; manifest-src 'self'; connect-src 'self'; font-src 'self'; img-src 'self' data:; script-src 'self'; style-src 'self' 'unsafe-inline' + Content-Security-Policy: default-src 'self'; frame-ancestors https://jamstackthemes.dev; manifest-src 'self' https://*.netlify.app; connect-src 'self' https://*.netlify.app; font-src 'self' https://*.netlify.app; img-src 'self' https://*.netlify.app data:; script-src 'self' https://*.netlify.app 'sha512-RBYr6Ld4w1yVqaACrgrBLQfPgGhj/1jyacA74WxJ1KM6KVcSWymwrdDwb3HDcdpwiNJ5yssot1He0U9vXoQVlg==' 'sha256-aWZ3y/RxbBYKHXH0z8+8ljrHG1mSBvyzSfxSMjBSaXk='; style-src 'self' https://*.netlify.app 'unsafe-inline' X-Frame-Options: SAMEORIGIN Referrer-Policy: strict-origin Feature-Policy: geolocation 'self' - Cache-Control: public, max-age=31536000 \ No newline at end of file + Cache-Control: public, max-age=31536000 + Access-Control-Allow-Origin: * \ No newline at end of file diff --git a/layouts/index.html b/layouts/index.html index 17fc2c64..451b57e7 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -1,74 +1,159 @@ {{ define "main" }} -{{ template "_internal/google_analytics.html" . }}
- FullStackHero Logo -

fullstackhero

-
-
- -

{{ .Params.lead | safeHTML }}

- -

{{ .Params.description | safeHTML }}

- Get Started -

fullstackhero is in it's early development stages.

+ fullstackhero Logo +

fullstackhero

+

{{ .Params.sub }}😎

+
+

What's fullstackhero?

+

Ever gone through the pain of setting up new Project from scratch each and every time? fullstackhero aims to + address this pain point by offering Starting Points aka Boilerplates for various technologies that can help + save + over 200+ hours of Development and Research Time for Developers and Teams.

+

fullstackhero offers Boilerplates with latest packages and services that your projects will ever need. We + intend to provide Clean and Well structured Boilerplates with top-notch quality following standard coding + practices and Clean Architecture principles that makes your development experience seemless. +

+

Most importantly, fullstackhero is completely FREE to use! 😍

+
+
+
+ Get Started 🚀 +

Open-source MIT Licensed. GitHub

+
+
{{ end }} {{ define "sidebar-prefooter" }} +{{ if eq $.Site.Language.LanguageName "English" }} +
+
+
+

Benefits of fullstackherođŸ”Ĩ

+

Here are few of the many reasons on why you should be excited about fullstackhero. +

+
+
+
+

Production Ready API

+

Get to work with the latest and greatest of Microsoft's .NET 7 Web API fused with the goodness of + fullstackhero.

+
+
+

Premium Client Applications

+

Blazor WebAssembly is the currently offered Boilerplate for fullstackhero's client side. Angular , React + and MVC on the way!

+
+
+

Multitenancy Support

+

Get a taste of the built-in Multitenancy feature integrated with the help of Finbuckle Multitenancy.

+
+
+
+
+

SOLID Architecture

+

fullstackhero is built with Scalability and Readabilty in mind. The source code is well structured and + easy to understand.

+
+
+

Well Documented

+

Compherensive documentation and jump start tutorials are available to keep you familiar with + fullstackhero.

+
+
+

Completely FREE!

+

The project is actively developed on GitHub under MIT licence and is open for contributions. +

+
+
+

Clean Seperation

+

API and Client Projects are seperated into various GitHub repositories to ensure that there is no dependency between the APIs and Client Applications. This enables us to accomodate various new technologies as both client and API applications in the future. +

+
+
+
+
+
-

Key Features

-

Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings - to your liking.

+

fullstackhero Projects

+

It's important to understand that fullstackhero provides seperate boilerplates for both API and Client Applications. These can be of various technologies and can be found in various repositories under the @fullstackhero handle on github!

- -
-
-

Clean Architecture

- fullstackhero follows Clean Architecture principles to keep the project highly - scalable in nature. -
-
-

Fast by default ⚡ī¸

-

Get 100 scores on Google - Lighthouse by default. Doks removes unused css, prefetches links, and lazy loads images.

-
-
-

Multitenancy Support

-

Out of the box Multitenancy support with Single Database per Tenant and Shared Database for Multiple Tenant - Approaches.

+
+
+
+
+

.NET 7 Web API Boilerplate 🚀

+
+
server
+
dotnet
+
multitenancy
+
aws
+
docker
+
+

Get to work with the latest and greatest of Microsoft's .NET 7 Web API fused with the goodness of + fullstackhero.

+

View Repository | Read Getting Started + Guide

+
+
+
+
+

Blazor WebAssembly Boilerplate 🚀

+
+
client application
+
dotnet
+
blazor webassembly
+
multitenancy
+
+

Clean Architecture Boilerplate Template for .NET 6.0 Blazor WebAssembly built for FSH WebAPI with the + goodness of MudBlazor Components.

+

View Repository | Read Getting Started + Guide

+
+
+
+

Angular Material Boilerplate

+

Coming Soon!

+
+
+

ASP.NET MVC Boilerplate

+

Coming Soon!

+
-
-
-

Well Documented

-

Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.

-
-
-

Saves 100+ Development Hours

-

Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit - your needs.

-
-
-

Free & Open Source

-

The project is actively developed on GitHub under MIT licence and is open for contributions.

+ +
+ +
+
+
+

Our Sponsors

+

The continued development and maintenance of fullstackhero is greatly helped by our generous sponsors..

+
+

+
+
+ +
-
-
+

Tools & Technologies

-

Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings - to your liking.

+

Built with tools and technologies that you are already familiar with.

.NET @@ -83,15 +168,15 @@

Tools & Technologies

.NET
+{{ end }} +{{ end }} -
-
-
-

The Community

-

Join our Discord to get the latest updates of the project.

-
-
- +{{ define "sidebar-footer" }} +
+
+
+ {{- .Content -}}
+
{{ end }} diff --git a/layouts/index.redirects b/layouts/index.redirects index 4323285c..5d7d6d27 100644 --- a/layouts/index.redirects +++ b/layouts/index.redirects @@ -1,6 +1,13 @@ -# redirects for Netlify - https://www.netlify.com/docs/redirects/ {{- range $p := .Site.Pages -}} {{- range .Aliases }} {{ . }} {{ $p.RelPermalink -}} {{- end }} -{{- end -}} \ No newline at end of file +{{- end -}} + +# /docs/1.0/prologue/ /docs/1.0/prologue/introduction/ +# /docs/1.0/help/ /docs/1.0/help/how-to-update/ +# /docs/1.0/ /docs/1.0/prologue/introduction/ +# /docs/ /docs/1.0/prologue/introduction/ +# +# /docs/0.1/* https://v0-1-0--doks-versioning-poc.netlify.app/docs/0.1/:splat 200 +# /docs/0.2/* https://v0-2-0--doks-versioning-poc.netlify.app/docs/0.2/:splat 200 diff --git a/layouts/partials/footer/alert.html b/layouts/partials/footer/alert.html deleted file mode 100644 index e03dfe77..00000000 --- a/layouts/partials/footer/alert.html +++ /dev/null @@ -1,3 +0,0 @@ - diff --git a/layouts/partials/footer/footer.html b/layouts/partials/footer/footer.html index 51aa126a..ceb5faec 100644 --- a/layouts/partials/footer/footer.html +++ b/layouts/partials/footer/footer.html @@ -1,5 +1,5 @@
-
+
    @@ -15,4 +15,4 @@
-
+ \ No newline at end of file diff --git a/layouts/partials/footer/script-footer.html b/layouts/partials/footer/script-footer.html index 64ccf136..ae06bbbc 100644 --- a/layouts/partials/footer/script-footer.html +++ b/layouts/partials/footer/script-footer.html @@ -45,6 +45,12 @@ {{ $slice = $slice | append $darkMode -}} {{ end -}} +{{ if and (.Site.Params.alert) (.Site.Params.alertDismissable) -}} + {{ $alert := resources.Get "js/alert.js" -}} + {{ $alert := $alert | js.Build -}} + {{ $slice = $slice | append $alert -}} +{{ end -}} + {{ if .Site.Params.options.kaTex -}} {{ $katexConfig := resources.Get "js/katex.js" -}} {{ $katexConfig := $katexConfig | js.Build -}} @@ -68,7 +74,7 @@ {{ with .Params.mermaid -}} {{ end -}} - {{ if .Site.Params.options.flexSearch -}} + {{ if and (.Site.Params.options.flexSearch) (in site.Params.mainSections .Section) -}} {{ end -}} {{ else -}} @@ -93,7 +99,7 @@ {{ with .Params.mermaid -}} {{ end -}} - {{ if .Site.Params.options.flexSearch -}} - + {{ if and (.Site.Params.options.flexSearch) (in site.Params.mainSections .Section) -}} + {{ end -}} -{{ end -}} \ No newline at end of file +{{ end -}} diff --git a/layouts/partials/head/head.html b/layouts/partials/head/head.html index ee7af14b..9c1ecb35 100644 --- a/layouts/partials/head/head.html +++ b/layouts/partials/head/head.html @@ -2,10 +2,9 @@ - {{ block "head/resource-hints" . }}{{ partial "head/resource-hints.html" . }}{{ end }} + {{ block "head/script-header" . }}{{ partial "head/script-header.html" . }}{{ end }} {{ block "head/stylesheet" . }}{{ partial "head/stylesheet.html" . }}{{ end }} {{ block "head/seo" . }}{{ partial "head/seo.html" . }}{{ end }} {{ block "head/favicons" . }}{{ partial "head/favicons.html" . }}{{ end }} - {{ block "head/script-header" . }}{{ partial "head/script-header.html" . }}{{ end }} - + \ No newline at end of file diff --git a/layouts/partials/head/script-header.html b/layouts/partials/head/script-header.html index e69de29b..38e5b5b9 100644 --- a/layouts/partials/head/script-header.html +++ b/layouts/partials/head/script-header.html @@ -0,0 +1,8 @@ +{{ if .Site.Params.options.darkMode -}} + {{ $darkModeInit := resources.Get "js/darkmode-init.js" | js.Build | minify -}} + +{{ end -}} +{{- if and (.Site.Params.alert) (.Site.Params.alertDismissable) -}} + {{ $alertInit := resources.Get "js/alert-init.js" | js.Build | minify -}} + +{{- end -}} \ No newline at end of file diff --git a/layouts/partials/head/seo.html b/layouts/partials/head/seo.html index 29aaef36..ac31d729 100644 --- a/layouts/partials/head/seo.html +++ b/layouts/partials/head/seo.html @@ -19,7 +19,11 @@ {{ with .Description -}} {{ else -}} - + {{ with .Summary | plainify -}} + + {{ else -}} + + {{ end -}} {{ end -}} {{ if $.Scratch.Get "paginator" }} diff --git a/layouts/partials/head/stylesheet.html b/layouts/partials/head/stylesheet.html index e5f9cc52..4dc25c01 100644 --- a/layouts/partials/head/stylesheet.html +++ b/layouts/partials/head/stylesheet.html @@ -1,7 +1,7 @@ {{ if eq (hugo.Environment) "development" -}} {{ $options := (dict "targetPath" "main.css" "enableSourceMap" true "includePaths" (slice "node_modules")) -}} {{ $css := resources.Get "scss/app.scss" | toCSS $options -}} - + {{ else -}} {{ $options := (dict "targetPath" "main.css" "outputStyle" "compressed" "includePaths" (slice "node_modules")) -}} {{ $css := resources.Get "scss/app.scss" | toCSS $options | postCSS (dict "config" "config/postcss.config.js") -}} diff --git a/layouts/partials/header/alert.html b/layouts/partials/header/alert.html new file mode 100644 index 00000000..7944ae96 --- /dev/null +++ b/layouts/partials/header/alert.html @@ -0,0 +1,10 @@ +{{ if .Site.Params.alertDismissable -}} + +{{ else -}} + +{{ end -}} \ No newline at end of file diff --git a/layouts/partials/header/header.html b/layouts/partials/header/header.html index 317671bc..e5347d9b 100644 --- a/layouts/partials/header/header.html +++ b/layouts/partials/header/header.html @@ -1,63 +1,242 @@ -
-
- - - - FullStackHero Logo - fullstackhero - - {{ if .Site.Params.options.darkMode -}} - - {{ end -}} - -
-
    - {{- $current := . -}} - {{ range .Site.Menus.main -}} - {{- $active := or ($current.IsMenuCurrent "main" .) ($current.HasMenuCurrent "main" .) -}} - {{- $active = or $active (eq .Name $current.Title) -}} - {{- $active = or $active (and (eq .Name "WebApi") (eq $current.Section "dotnet-webapi-boilerplate")) -}} - {{- $active = or $active (and (eq .Name "Angular") (eq $current.Section "angular-material-boilerplate")) -}} - {{- $active = or $active (and (eq .Name "Blog") (eq $current.Section "blog" "authors")) -}} -
  • - {{ .Name }} + {{ if eq .Site.Params.options.multilingualMode true -}} +
    + + +
    + {{ end -}} + +
+ + {{ if eq .Site.Params.options.flexSearch false }} +
+{{ end -}} + +{{ if in site.Params.mainSections .Section -}} + + +
+ +
+ +{{ else if ne .CurrentSection .FirstSection -}} + + +
+ +
+{{ end -}} diff --git a/layouts/partials/main/date.html b/layouts/partials/main/date.html new file mode 100644 index 00000000..4b41ddb3 --- /dev/null +++ b/layouts/partials/main/date.html @@ -0,0 +1,6 @@ + +{{ $format := default "January 2, 2006" .Format -}} +{{ return (.Date.Format $format) -}} \ No newline at end of file diff --git a/layouts/partials/main/docs-navigation.html b/layouts/partials/main/docs-navigation.html index bdf071d9..8b386eda 100644 --- a/layouts/partials/main/docs-navigation.html +++ b/layouts/partials/main/docs-navigation.html @@ -1,33 +1,33 @@ {{ if or .Prev .Next -}} -
- - {{ $pages := where site.RegularPages "Section" .Section -}} - {{ with $pages.Next . -}} - -
-
- ← {{ .Title }} -
-
- - {{ end -}} - {{ with $pages.Prev . -}} - -
-
- {{ .Title }} → -
-
- - {{ end -}} -
+
+ + {{ $pages := where site.RegularPages "Section" .Section -}} + {{ with $pages.Next . -}} + +
+
+ ← {{ .Title }} +
+
+ + {{ end -}} + {{ with $pages.Prev . -}} + +
+
+ {{ .Title }} → +
+
+ + {{ end -}} +
{{ end -}} -
-

Like fullstackhero?

-

Support the project by buying me a coffee!

+
+

Like fullstackhero? ❤ī¸

+

Here is what you can do to show your support!

Buy - me - a Coffee -
+ href="https://www.buymeacoffee.com/codewithmukesh" target="_blank" role="button">Buy me a Coffee ☕ + Sponsor 😍 +
diff --git a/layouts/partials/main/edit-page.html b/layouts/partials/main/edit-page.html index f3108bb4..30c0dba2 100644 --- a/layouts/partials/main/edit-page.html +++ b/layouts/partials/main/edit-page.html @@ -1,7 +1,22 @@ - - - Edit this Document on GitHub +{{ $filePath := replace .File.Path "\\" "/" }} +{{ $editPath := "null" }} + +{{ if (eq .Site.Params.repoHost "GitHub") }} + {{ $editPath = "/blob/" }} +{{ else if (eq .Site.Params.repoHost "Gitea") }} + {{ $editPath = "/_edit/" }} +{{ else if (eq .Site.Params.repoHost "GitLab") }} + {{ $editPath = "/-/blob/" }} +{{ end }} + +{{ $contentPath := print .Site.Params.docsRepo $editPath .Site.Params.docsRepoBranch "/content/" }} +{{ $url := print $contentPath .Lang "/" $filePath }} + +
+ + + + + Edit this page on {{ .Site.Params.repoHost }} + +
diff --git a/layouts/partials/main/headline-hash.html b/layouts/partials/main/headline-hash.html deleted file mode 100644 index 826fa32d..00000000 --- a/layouts/partials/main/headline-hash.html +++ /dev/null @@ -1 +0,0 @@ -{{ . | replaceRE "()" `${1} ${3}` | safeHTML }} \ No newline at end of file diff --git a/layouts/partials/main/last-modified.html b/layouts/partials/main/last-modified.html new file mode 100644 index 00000000..edb6c7d0 --- /dev/null +++ b/layouts/partials/main/last-modified.html @@ -0,0 +1,10 @@ +{{ if and .GitInfo .Site.Params.docsRepo -}} + {{- $date := partial "main/date" (dict "Date" .GitInfo.AuthorDate.Local "Format" .Site.Params.BookDateFormat) -}} + {{- $commitPath := default "commit" .Site.Params.BookCommitPath -}} +
+ + + Last modified on {{ $date }} + +
+{{ end -}} \ No newline at end of file diff --git a/layouts/partials/main/view-counter.html b/layouts/partials/main/view-counter.html index ecf3c746..cc5dea2d 100644 --- a/layouts/partials/main/view-counter.html +++ b/layouts/partials/main/view-counter.html @@ -1,6 +1,14 @@
+ src="https://api.visitorbadge.io/api/visitors?path={{.Permalink}}&label=Views&labelColor=%233eaf7c&countColor=%231b1f22&style=flat-square" /> + + + + + +
diff --git a/layouts/partials/sidebar/auto-collapsible-menu.html b/layouts/partials/sidebar/auto-collapsible-menu.html new file mode 100644 index 00000000..09f2f6c0 --- /dev/null +++ b/layouts/partials/sidebar/auto-collapsible-menu.html @@ -0,0 +1,57 @@ + +
    + {{ $currentPage := . -}} + {{ $section := $currentPage.Section -}} + {{ range (where .Site.Sections "Section" "in" $section) }} + {{ range .Sections.Reverse }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
  • + +
    +
      + {{ range .Pages }} + {{ if .IsNode }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
    • + +
      +
        + {{ range .Pages }} + {{ if .IsNode }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
      • + +
        +
          + {{ range .Pages }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
        • {{ .Title }}
          • + {{ end }} +
        +
        +
        • + {{ else }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
      • {{ .Title }}
        • + {{ end }} + {{ end }} +
      +
      +
      • + {{ else }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
    • {{ .Title }}
      • + {{ end }} + {{ end }} +
    +
    +
    • + {{ end }} + {{ end }} +
\ No newline at end of file diff --git a/layouts/partials/sidebar/auto-default-menu.html b/layouts/partials/sidebar/auto-default-menu.html new file mode 100644 index 00000000..5f388eeb --- /dev/null +++ b/layouts/partials/sidebar/auto-default-menu.html @@ -0,0 +1,37 @@ + +{{ $currentPage := . -}} +{{ $section := $currentPage.Section -}} +{{ range (where .Site.Sections "Section" "in" $section) }} + {{ range .Sections.Reverse }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +

{{ .Title }}

+
    + {{ range .Pages }} + {{ if .IsNode }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +

    {{ .Title }}

    +
      + {{ range .Pages }} + {{ if .IsNode }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
      {{ .Title }}
      +
        + {{ range .Pages }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
      • {{ .Name }}
        • + {{ end }} +
      + {{ else }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
    • {{ .Name }}
      • + {{ end }} + {{ end }} +
    + {{ else }} + {{ $active := in $currentPage.RelPermalink .RelPermalink }} +
  • {{ .Name }}
    • + {{ end }} + {{ end }} +
+ {{ end }} +{{ end }} diff --git a/layouts/partials/sidebar/docs-menu.html b/layouts/partials/sidebar/docs-menu.html index e3dc2419..93093f76 100644 --- a/layouts/partials/sidebar/docs-menu.html +++ b/layouts/partials/sidebar/docs-menu.html @@ -1,36 +1,9 @@ -{{ $currentPage := . -}} -{{ range .Site.Menus.docs -}} - {{- $active := or (eq $currentPage.RelPermalink .URL) ($currentPage.HasMenuCurrent "docs" .) -}} - {{- $collapsible := eq .Name "Reference" }} -

- {{ if $collapsible -}} - - {{ .Name }} - - - {{ else -}} - {{ .Name }} - {{ end -}} -

- {{ if .HasChildren -}} - - {{ end -}} +{{ if and .Site.Params.menu.section.auto .Site.Params.menu.section.collapsibleSidebar -}} + {{ partial "sidebar/auto-collapsible-menu.html" . -}} +{{ else if and .Site.Params.menu.section.auto (not .Site.Params.menu.section.collapsibleSidebar) -}} + {{ partial "sidebar/auto-default-menu.html" . -}} +{{ else if and (not .Site.Params.menu.section.auto) .Site.Params.menu.section.collapsibleSidebar -}} + {{ partial "sidebar/manual-collapsible-menu.html" . -}} +{{ else if and (not .Site.Params.menu.section.auto) (not .Site.Params.menu.section.collapsibleSidebar) -}} + {{ partial "sidebar/manual-default-menu.html" . -}} {{ end -}} diff --git a/layouts/partials/sidebar/docs-toc.html b/layouts/partials/sidebar/docs-toc.html index 880daad6..924e8908 100644 --- a/layouts/partials/sidebar/docs-toc.html +++ b/layouts/partials/sidebar/docs-toc.html @@ -1,18 +1,36 @@ -{{ if ne .Params.toc false -}} -
-
SUPPORT THE PROJECT
-

- Like fullstackhero? Support the project by buying me a coffee! -

- Buy me - a Coffee -
-{{ if ge (len .TableOfContents) 100 }} -
-

On this page

- {{ .TableOfContents }} -
-{{ end }} - -{{ end -}} +
+
+
WATCH OVERVIEW VIDEO
+

+ A Quick Video about how you can get started with the .NET 7 Web API Boilerplate. Watch this first!đŸ”Ĩ +

+ + Subscribe to my YouTube + Channel +
+
+
+
SUPPORT THE PROJECT
+

+ Here is what you can do to show your support! +

+ Buy me + a Coffee ☕ + Sponsor 😍 +
+
+
+ {{ if and (ne .Params.toc false) (ne .TableOfContents "") -}} +
+

Contents On this page

+ {{ .TableOfContents }} +
+ {{ end -}} +
diff --git a/layouts/partials/sidebar/manual-collapsible-menu.html b/layouts/partials/sidebar/manual-collapsible-menu.html new file mode 100644 index 00000000..926f6eb2 --- /dev/null +++ b/layouts/partials/sidebar/manual-collapsible-menu.html @@ -0,0 +1,63 @@ + +
    + {{ $currentPage := . -}} + {{ $section := $currentPage.Section -}} + {{ range (index .Site.Menus $section) -}} + {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}} + {{- $active = or $active (eq $currentPage.Section .Identifier) -}} +
  • + + {{ if .HasChildren -}} +
    +
      + {{ range .Children -}} + {{ if .HasChildren -}} +
    • + + {{ if .HasChildren -}} +
      +
        + {{ range .Children -}} + {{ if .HasChildren -}} +
      • + + {{ if .HasChildren -}} +
        +
          + {{ range .Children -}} + {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}} + {{- $active = or $active (eq $currentPage.Section .Identifier) -}} +
        • {{ .Name }}
          • + {{ end -}} +
        +
        + {{ end -}} +
        • + {{ else -}} + {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}} + {{- $active = or $active (eq $currentPage.Section .Identifier) -}} +
      • {{ .Name }}
        • + {{ end -}} + {{ end -}} +
      +
      + {{ end -}} +
      • + {{ else -}} + {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}} + {{- $active = or $active (eq $currentPage.Section .Identifier) -}} +
    • {{ .Name }}
      • + {{ end -}} + {{ end -}} +
    +
    + {{ end -}} +
    • + {{ end -}} +
\ No newline at end of file diff --git a/layouts/partials/sidebar/manual-default-menu.html b/layouts/partials/sidebar/manual-default-menu.html new file mode 100644 index 00000000..24c2c99d --- /dev/null +++ b/layouts/partials/sidebar/manual-default-menu.html @@ -0,0 +1,41 @@ + +{{ $currentPage := . -}} +{{ $section := $currentPage.Section -}} +{{ range (index .Site.Menus $section) -}} +

{{ .Name }}

+ {{ if .HasChildren -}} +
    + {{ range .Children -}} + {{ if .HasChildren -}} +

    {{ .Name }}

    + {{ if .HasChildren -}} +
      + {{ range .Children -}} + {{ if .HasChildren -}} +
      {{ .Name }}
      + {{ if .HasChildren -}} +
        + {{ range .Children -}} + {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}} + {{- $active = or $active (eq $currentPage.Section .Identifier) -}} +
      • {{ .Name }}
        • + {{ end -}} +
      + {{ end -}} + {{ else -}} + {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}} + {{- $active = or $active (eq $currentPage.Section .Identifier) -}} +
    • {{ .Name }}
      • + {{ end -}} + {{ end -}} +
    + {{ end -}} + {{ else -}} + {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}} + {{- $active = or $active (eq $currentPage.Section .Identifier) -}} +
  • {{ .Name }}
    • + {{ end -}} + {{ end -}} +
+ {{ end -}} +{{ end -}} diff --git a/layouts/partials/sidebar/webapi-menu.html b/layouts/partials/sidebar/webapi-menu.html deleted file mode 100644 index 90503d99..00000000 --- a/layouts/partials/sidebar/webapi-menu.html +++ /dev/null @@ -1,36 +0,0 @@ -{{ $currentPage := . -}} -{{ range .Site.Menus.webapi -}} - {{- $active := or (eq $currentPage.RelPermalink .URL) ($currentPage.HasMenuCurrent "webapi" .) -}} - {{- $collapsible := eq .Name "Reference" }} -

- {{ if $collapsible -}} - - {{ .Name }} - - - {{ else -}} - {{ .Name }} - {{ end -}} -

- {{ if .HasChildren -}} - - {{ end -}} -{{ end -}} diff --git a/layouts/rss.xml b/layouts/rss.xml index 72ac5647..b8f563e9 100644 --- a/layouts/rss.xml +++ b/layouts/rss.xml @@ -7,8 +7,8 @@ Hugo -- gohugo.io{{ with .Site.LanguageCode }} {{.}}{{end}}{{ with .Site.Author.email }} {{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}}{{ with .Site.Author.email }} - {{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}}{{ with .Site.Copyright }} - {{.}}{{end}}{{ if not .Date.IsZero }} + {{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}}{{ with .Site.Params.copyRight }} + {{ . | safeHTML }}{{end}}{{ if not .Date.IsZero }} {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}{{ end }} {{ with .OutputFormats.Get "RSS" }} {{ printf "" .Permalink .MediaType | safeHTML }} diff --git a/layouts/shortcodes/alert.html b/layouts/shortcodes/alert.html index 7cc7eb08..e2abe8ed 100644 --- a/layouts/shortcodes/alert.html +++ b/layouts/shortcodes/alert.html @@ -1,4 +1,4 @@ -