Merge pull request #2 from NickvisionApps/rewrite

Rewrite

.editorconfig

@@ -0,0 +1,14 @@
+[*.{sln,resx}]
+indent_style = tab
+
+[*.{cs,sh,py,json}]
+indent_style = space
+indent_size = 4
+
+[*.{csproj,xml,css,md,blp}]
+indent_style = space
+indent_size = 2
+
+[justfile]
+indent_style = space
+indent_size = 4

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: nlogozzo
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/build.yml

@@ -0,0 +1,64 @@
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+    types: [ "review_requested", "ready_for_review" ]
+  workflow_dispatch:
+name: CI
+jobs:
+  winui:
+    name: "WinUI"
+    strategy:
+      matrix:
+        configuration: [Release]
+        platform: [x64, arm64]
+    runs-on: windows-latest
+    if: ${{ github.event.pull_request.user.login != 'weblate' }}
+    env:
+      Solution_Name: NickvisionSpotlight.sln
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3.5.0
+      with:
+        fetch-depth: 0
+    # Install the .NET Core workload
+    - name: Install .NET Core
+      uses: actions/setup-dotnet@v3.0.3
+      with:
+        dotnet-version: 7.0.x
+    # Add  MSBuild to the PATH: https://github.com/microsoft/setup-msbuild
+    - name: Setup MSBuild.exe
+      uses: microsoft/setup-msbuild@v1.3.1
+    # Restore the application to populate the obj folder with RuntimeIdentifiers
+    - name: Restore the application
+      run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration
+      env:
+        Configuration: ${{ matrix.configuration }}
+    # Decode the base 64 encoded pfx and save the Signing_Certificate
+    - name: Decode the pfx
+      env:
+         PfxPath: ${{ github.workspace }}\GitHubActionsWorkflow.pfx
+      run: |
+        $pfx_cert_byte = [System.Convert]::FromBase64String("${{ secrets.BASE64_ENCODED_PFX }}")
+        $certificatePath = $env:PfxPath
+        [IO.File]::WriteAllBytes("$certificatePath", $pfx_cert_byte)
+    # Create the app package by building and packaging the project
+    - name: Create the app package
+      run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration /p:Platform=$env:Platform /p:UapAppxPackageBuildMode=$env:Appx_Package_Build_Mode /p:AppxBundle=$env:Appx_Bundle /p:AppxPackageSigningEnabled=true /p:PackageCertificateThumbprint="" /p:PackageCertificateKeyFile="$env:Pfx_Path" /p:AppxPackageDir="$env:Appx_Package_Dir" /p:GenerateAppxPackageOnBuild=true
+      env:
+        Pfx_Path: ${{ github.workspace }}\GitHubActionsWorkflow.pfx
+        Appx_Bundle: Always
+        Appx_Package_Build_Mode: StoreUpload
+        Appx_Package_Dir: Packages\
+        Configuration: ${{ matrix.configuration }}
+        Platform: ${{ matrix.platform }}
+    # Remove the pfx
+    - name: Remove the pfx
+      run: Remove-Item -path GitHubActionsWorkflow.pfx
+    # Upload the app
+    - name: Upload app
+      uses: actions/upload-artifact@v3.1.2
+      with:
+        name: org.nickvision.spotlight-winui-${{ matrix.platform }}
+        path: ${{ github.workspace }}\NickvisionSpotlight.WinUI\Packages

.github/workflows/security.yml

@@ -0,0 +1,56 @@
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+    types: [ "review_requested", "ready_for_review" ]
+  schedule:
+    - cron: '21 11 * * 0'
+name: CodeQL
+jobs:
+  windows:
+    name: Security Analysis
+    strategy:
+      matrix:
+        configuration: [Release]
+        platform: [x64]
+    runs-on: windows-latest
+    if: ${{ github.event.pull_request.user.login != 'weblate' }}
+    env:
+      Solution_Name: NickvisionSpotlight.sln
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3.5.0
+        with:
+          fetch-depth: 0
+      # Install the .NET Core workload
+      - name: Install .NET Core
+        uses: actions/setup-dotnet@v3.0.3
+        with:
+          dotnet-version: 7.0.x
+      # Add MSBuild to the PATH: https://github.com/microsoft/setup-msbuild
+      - name: Setup MSBuild.exe
+        uses: microsoft/setup-msbuild@v1.3.1
+      # Setup CodeQL
+      - name: Setup CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: csharp
+      # Restore
+      - name: Restore Solution
+        run: msbuild $env:Solution_Name /t:Restore /p:Configuration=$env:Configuration
+        env:
+          Configuration: ${{ matrix.configuration }}
+      # Build
+      - name: Build Solution
+        run: msbuild $env:Solution_Name /p:Configuration=$env:Configuration /p:Platform=$env:Platform
+        env:
+          Configuration: ${{ matrix.configuration }}
+          Platform: ${{ matrix.platform }}
+      # Analyze
+      - name: Analyze
+        uses: github/codeql-action/analyze@v2

.github/workflows/spelling.yml

@@ -0,0 +1,17 @@
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+    types: [ "review_requested", "ready_for_review" ]
+name: Spell Check
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: codespell-project/actions-codespell@master
+        with:
+          check_filenames: true
+          skip: cargo-sources.json,.git,Strings.*.resx,*.svg
+          ignore_words_list: gir

.gitignore

@@ -336,3 +336,14 @@ ASALocalRun/
 
 #Intellij
 .idea/
+
+#Resources
+*.Designer.cs
+
+# Flatpak Builder
+.flatpak-builder/
+.flatpak/
+
+# Temporary build files
+_nickbuild/
+*.ui

CONTRIBUTING.md

@@ -0,0 +1,162 @@
+# Contributing to Nickvision Spotlight
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+
+> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+> - Star the project
+> - Tweet about it
+> - Refer this project in your project's readme
+> - [Sponsor](https://github.com/sponsors/nlogozzo) the lead developer
+
+## Table of Contents
+
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Enhancements/New Features](#suggesting-enhancements)
+  - [Providing translations](#providing-translations)
+    - [Via Weblate](#via-weblate)
+    - [Manually](#manually)
+  - [Your First Code Contribution](#your-first-code-contribution)
+    - [Developing on Windows](#developing-on-windows)
+    - [Developing on Linux](#developing-on-linux)
+- [Styleguides](#styleguides)
+- [Join The Project Team](#join-the-project-team)
+
+## I Have a Question
+
+Before you ask a question, it is best to search for existing [Discussions](https://github.com/NickvisionApps/Spotlight/discussions) and [Issues](https://github.com/NickvisionApps/Spotlight/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this discussion post. It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open a [Discussion](https://github.com/NickvisionApps/Spotlight/discussions).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (windows, gnome, etc...), depending on what seems relevant.
+
+We will then take care of the question as soon as possible.
+
+## I Want To Contribute
+
+> ### Legal Notice
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest released version.
+- Determine if your bug is really a bug and not an error on your side. If you are looking for support, you might want to check [this section](#i-have-a-question).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in both the [Discussions](https://github.com/NickvisionApps/Spotlight/discussions) and [Issues](https://github.com/NickvisionApps/Spotlight/issues) sections.
+- Collect information about the bug:
+  - Stack trace (Traceback)
+    - Including any error messages thrown by the application
+    - You may need to start the application via the terminal/console to receive an error message for a crash.
+  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+  - Possibly your input and the output
+  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <nlogozzo225@gmail.com>.
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/NickvisionApps/Spotlight/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps. Bugs that are not able to be reproduced will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked as a `bug` and the issue will be left to be [implemented by someone](#your-first-code-contribution).
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for Nickvision Spotlight, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest released version.
+- Perform a search through [Discussions](https://github.com/NickvisionApps/Spotlight/discussions) and [Issues](https://github.com/NickvisionApps/Spotlight/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/NickvisionApps/Spotlight/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://flathub.org/apps/details/io.github.seadve.Kooha) on Linux.
+- **Explain why this enhancement would be useful** to most Nickvision Spotlight users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+### Providing Translations
+
+Everyone is welcome to translate this app into their native or known languages, so that the application is accessible to everyone.
+
+#### Via Weblate
+
+Spotlight is available to translate on [Weblate](https://hosted.weblate.org/engage/nickvision-spotlight/)!
+
+#### Manually
+
+To start translating the app, fork the repository and clone it locally.
+
+In the `NickvisionSpotlight.Shared/Resources` folder you will see a file called `String.resx`. This is a C# resource file that contains all the strings for the application. Simply copy that file and rename it `String.<lang-code>.resx`. For example, if I'm creating an Italian translation, the copied file would be called `Strings.it.resx`. Once you have your copied file, simply replace each `<value>` block of each `<data>` string block with your language's appropriate translation.
+
+To check your translation file, make sure your system is in the locale of the language you are translating and run the app. You should see your translated strings!
+
+Once all changes to your translated file are made, make sure the file is in the path `NickvisionSpotlight.Shared/Resources/String.<lang-code>.resx`, commit these changes and create a pull request to the project.
+
+### Your First Code Contribution
+
+Spotlight is built using .NET 7 and C#. With these technologies, Spotlight is built for Windows only.
+The solution is setup into 2 projects:
+ - NickvisionApplication.Shared
+ - NickvisionApplication.WinUI
+
+The whole solution utilizes the [MVC](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) pattern for separating data and UI views.
+
+#### NickvisionApplication.Shared
+
+This project contains all of the code used by all platforms of the app. 
+- Models => The data driven objects of the application (i.e. Configuration, Database, etc...)
+- Controllers => The objects used by UI views to receive and manipulate data from the Models
+- Helpers => Useful objects such as the Localizer for receiving translated strings throughout the app
+- Resources => Strings, icons, and fonts used by the app
+
+#### NickvisionApplication.WinUI
+
+This project contains all of the code used for the Windows platform version of the app.
+Powered by the [WindowsAppSDK](https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/)
+- Views => The views (pages, windows, dialogs) of the app that connect to the shared controllers
+- Controls => Generic controls for the app
+  - These controls should not be connected to a controller and should be able to be ported to any other application 
+
+#### Developing on Windows
+
+Recommended IDE:
+- Visual Studio 2019 or Visual Studio 2022 with the required workloads (including .NET 7) and components for Windows app development. For more information, see [Install tools for the Windows App SDK](https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/set-up-your-development-environment?tabs=cs-vs-community%2Ccpp-vs-community%2Cvs-2022-17-1-a%2Cvs-2022-17-1-b)
+
+Although, any IDE that supports .NET 7 and WindowsAppSDK should work.
+
+*Rider does support .NET 7, but has no WindowsAppSDK support at the time of writing this. Therefore, you will be able to develop part of the application use Rider, but will be unable to build and run the Windows platform version.*
+
+## Styleguides
+
+Application follows [Microsoft's C# Coding Conventions](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions).
+
+See [Microsoft's C# Identifier Names](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/identifier-names) as well.
+
+## Join The Project Team
+
+<a href='https://matrix.to/#/#nickvision:matrix.org'><img width='140' alt='Join our room' src='https://user-images.githubusercontent.com/17648453/196094077-c896527d-af6d-4b43-a5d8-e34a00ffd8f6.png'/></a>
+
+## Attribution
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

LICENSE

@@ -1,7 +1,7 @@
-Copyright (c) 2021-2022 Nicholas Logozzo
+Copyright (c) 2021-2023 Nicholas Logozzo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.