Merge pull request #5 from webexpress-framework/develop

0.0.9-alpha

Author: ReneSchwarzer

.github/workflows/generate-docs.yml

@@ -36,6 +36,10 @@ jobs:
     - name: Add DocFX to PATH
       run: echo "$HOME/.dotnet/tools" >> $GITHUB_PATH
 
+    - name: Build WebExpress.WebIndex
+      run: |
+        dotnet build ./src/WebExpress.WebIndex/WebExpress.WebIndex.csproj -c Release
+
     - name: Generate documentation
       run: |
         cd docs 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 René Schwarzer
+Copyright (c) 2025 René Schwarzer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,7 @@
-![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
+![WebExpress-Framework](https://raw.githubusercontent.com/webexpress-framework/.github/main/docs/assets/img/banner.png)
 
 # WebExpress
-`WebExpress` is a lightweight web server optimized for use in low-performance environments (e.g. Rasperry PI). By providing 
-a powerful plugin system and a comprehensive API, web applications can be easily and quickly integrated into a .net 
-language (e.g. C#). Some advantages of `WebExpress` are:
+`WebExpress` is a lightweight web server optimized for use in low-performance environments (e.g. Rasperry PI). By providing a powerful plugin system and a comprehensive API, web applications can be easily and quickly integrated into a .net language (e.g. C#). Some advantages of `WebExpress` are:
 
 - It is easy to use.
 - It offers a variety of features and tools that can help you build and manage your website.
@@ -12,34 +10,35 @@ language (e.g. C#). Some advantages of `WebExpress` are:
 
 The `WebExpress` family includes the following projects:
 
-- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for `WebExpress` applications and the documentation.
-- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for `WebExpress` applications.
-- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for `WebExpress` applications.
-- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for `WebExpress` applications.
-- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for `WebExpress` applications.
+- [WebExpress](https://github.com/webexpress-framework/WebExpress#readme) - The web server for `WebExpress` applications and the documentation.
+- [WebExpress.WebCore](https://github.com/webexpress-framework/WebExpress.WebCore#readme) - The core for `WebExpress` applications.
+- [WebExpress.WebUI](https://github.com/webexpress-framework/WebExpress.WebUI#readme) - Common templates and controls for `WebExpress` applications.
+- [WebExpress.WebIndex](https://github.com/webexpress-framework/WebExpress.WebIndex#readme) - Reverse index for `WebExpress` applications.
+- [WebExpress.WebApp](https://github.com/webexpress-framework/WebExpress.WebApp#readme) - Business application template for `WebExpress` applications.
 
 # WebExpress.WebIndex
-`WebExpress.WebIndex` is part of the WebExpress family. The project provides a reverse index to enable a quick and efficient search for data. The index can be filtered using the wql (webexpress query language). Even though the reverse index is part of the `WebExpress` family, it can also be used in other projects (outside of `WebExpress`). For detailed information about `WebIndex`, see [concept](https://github.com/ReneSchwarzer/WebExpress.WebIndex/blob/main/docs/concept.md).
+`WebExpress.WebIndex` is part of the WebExpress family. The project provides a reverse index to enable a quick and efficient search for data. The index can be filtered using the wql (webexpress query language). Even though the reverse index is part of the `WebExpress` family, it can also be used in other projects (outside of `WebExpress`). For detailed information about `WebIndex`, see [concept](https://github.com/webexpress-framework/WebExpress.WebIndex/blob/main/docs/concept.md).
 
 # Download 
-The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).
+The current binaries are available for download [here](https://github.com/webexpress-framework/WebExpress/releases).
 
 # Start
 If you're looking to get started with `WebExpress`, we would recommend using the following documentation. It can help you understand the platform.
 
-- [Installation Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/installation_guide.md) 
-- [Development Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/development_guide.md)
-- [WebExpress.WebCore API Documentation](https://reneschwarzer.github.io/WebExpress.WebCore/) 
-- [WebExpress.WebUI API Documentation](https://reneschwarzer.github.io/WebExpress.WebUI/) 
-- [WebExpress.WebApp API Documentation](https://reneschwarzer.github.io/WebExpress.WebApp/) 
-- [WebExpress.WebIndex API Documentation](https://reneschwarzer.github.io/WebExpress.WebIndex/) 
+- [Installation Guide](https://github.com/webexpress-framework/WebExpress/blob/main/doc/installation_guide.md) 
+- [Development Guide](https://github.com/webexpress-framework/WebExpress/blob/main/doc/development_guide.md)
+- [WebExpress.WebCore API Documentation](https://webexpress-framework.github.io/WebExpress.WebCore/) 
+- [WebExpress.WebUI API Documentation](https://webexpress-framework.github.io/WebExpress.WebUI/) 
+- [WebExpress.WebApp API Documentation](https://webexpress-framework.github.io/WebExpress.WebApp/) 
+- [WebExpress.WebIndex API Documentation](https://webexpress-framework.github.io/WebExpress.WebIndex/) 
 
 # Learning
 The following tutorials illustrate the essential techniques of `WebExpress`. These tutorials are designed to assist you, as a developer, in understanding the various aspects of `WebExpress`. Each tutorial provides a detailed, step-by-step guide that you can work through using an example. If you’re interested in beginning the development of `WebExpress` components, we would recommend you to complete some of these tutorials.
 
-- [HelloWorld](https://github.com/ReneSchwarzer/WebExpress.Tutorial.HelloWorld#readme)
-- [WebApp](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebApp#readme)
-- [WebIndex](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebIndex#readme)
+- [HelloWorld](https://github.com/webexpress-framework/WebExpress.Tutorial.HelloWorld#readme)
+- [WebUI](https://github.com/webexpress-framework/WebExpress.Tutorial.WebUI#readme)
+- [WebApp](https://github.com/webexpress-framework/WebExpress.Tutorial.WebApp#readme)
+- [WebIndex](https://github.com/webexpress-framework/WebExpress.Tutorial.WebIndex#readme)
 
 # Tags
 #WebIndex #WebExpress #ReverseIndex #DotNet #NETCore

docs/concept.md

@@ -1,4 +1,4 @@
-![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress.Doc/main/assets/banner.png)
+![WebExpress-Framework](https://raw.githubusercontent.com/webexpress-framework/.github/main/docs/assets/img/banner.png)
 
 # WebExpress.WebIndex
 The index model provides a reverse index to enable fast and efficient searching. A reverse 

docs/docfx.json

@@ -51,7 +51,7 @@
     "xref": [
       "../.xrefmap.json"
     ],
-    "output": "../_site",
+    "output": "_site",
     "template": [
       "default",
       "modern",

docs/index.md

@@ -1,4 +1,4 @@
-![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
+![WebExpress-Framework](https://raw.githubusercontent.com/webexpress-framework/.github/main/docs/assets/img/banner.png)
 
 # WebExpress
 WebExpress is a lightweight web server optimized for use in low-performance environments (e.g. Raspberry PI). By providing 
@@ -12,17 +12,17 @@ language (e.g. C#). Some advantages of WebExpress are:
 
 The `WebExpress` family includes the following projects:
 
-- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for `WebExpress` applications and the documentation.
-- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for `WebExpress` applications.
-- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for `WebExpress` applications.
-- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for `WebExpress` applications.
-- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for `WebExpress` applications.
+- [WebExpress](https://github.com/webexpress-framework/WebExpress#readme) - The web server for `WebExpress` applications and the documentation.
+- [WebExpress.WebCore](https://github.com/webexpress-framework/WebExpress.WebCore#readme) - The core for `WebExpress` applications.
+- [WebExpress.WebUI](https://github.com/webexpress-framework/WebExpress.WebUI#readme) - Common templates and controls for `WebExpress` applications.
+- [WebExpress.WebIndex](https://github.com/webexpress-framework/WebExpress.WebIndex#readme) - Reverse index for `WebExpress` applications.
+- [WebExpress.WebApp](https://github.com/webexpress-framework/WebExpress.WebApp#readme) - Business application template for `WebExpress` applications.
 
 # WebExpress.WebIndex
-`WebExpress.WebIndex` is part of the WebExpress family. The project provides a reverse index to enable a quick and efficient search for data. The index can be filtered using the wql (webexpress query language). Even though the reverse index is part of the `WebExpress` family, it can also be used in other projects (outside of `WebExpress`). For detailed information about `WebIndex`, see [concept](https://github.com/ReneSchwarzer/WebExpress.WebIndex/blob/main/docs/concept.md).
+`WebExpress.WebIndex` is part of the WebExpress family. The project provides a reverse index to enable a quick and efficient search for data. The index can be filtered using the wql (webexpress query language). Even though the reverse index is part of the `WebExpress` family, it can also be used in other projects (outside of `WebExpress`). For detailed information about `WebIndex`, see [concept](https://github.com/webexpress-framework/WebExpress.WebIndex/blob/main/docs/concept.md).
 
 # Download 
-The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).
+The current binaries are available for download [here](https://github.com/webexpress-framework/WebExpress/releases).
 
 # Tags
 #WebIndex #WebExpress #ReverseIndex #DotNet #NETCore

docs/toc.yml

@@ -1,7 +1,7 @@
 - name: Home
   href: index.md
 - name: API Documentation
-  href: api/WebExpress.WebIndex.html
+  href: api/
 - name: Concept
   href: concept.md
 - name: User Guide

docs/tutorials.md

@@ -1,4 +1,4 @@
-![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
+![WebExpress-Framework](https://raw.githubusercontent.com/webexpress-framework/.github/main/docs/assets/img/banner.png)
 
 # Tutorials
 Welcome to the `WebExpress` Tutorials! Here, you'll find step-by-step guides and helpful resources to get the most out 
@@ -7,9 +7,10 @@ our tutorials offer something for everyone.
 
 # Getting Started
 Begin with our basic tutorial:
-- [HelloWorld](https://github.com/ReneSchwarzer/WebExpress.Tutorial.HelloWorld#readme)
-- [WebApp](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebApp#readme)
-- [WebIndex](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebIndex#readme)
+- [HelloWorld](https://github.com/webexpress-framework/WebExpress.Tutorial.HelloWorld#readme)
+- [WebUI](https://github.com/webexpress-framework/WebExpress.Tutorial.WebUI#readme)
+- [WebApp](https://github.com/webexpress-framework/WebExpress.Tutorial.WebApp#readme)
+- [WebIndex](https://github.com/webexpress-framework/WebExpress.Tutorial.WebIndex#readme)
 
 This tutorial will guide you through the initial steps of creating and running your first `WebExpress` application.
 

docs/user-guide.md

@@ -1,4 +1,4 @@
-![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
+![WebExpress-Framework](https://raw.githubusercontent.com/webexpress-framework/.github/main/docs/assets/img/banner.png)
 
 # User guide
 Welcome to the `WebExpress.WebIndex` User Guide. This guide will help you get started with `WebExpress.WebIndex` and make the most out of its 
@@ -7,11 +7,11 @@ features. Follow the links below to begin your journey.
 # Getting started
 To get started with `WebExpress.WebIndex`, use the following guides:
 
-- [Installation Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/installation_guide.md) 
-- [Development Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/development_guide.md)
-- [WebExpress.WebCore API Documentation](https://reneschwarzer.github.io/WebExpress.WebCore/) 
-- [WebExpress.WebUI API Documentation](https://reneschwarzer.github.io/WebExpress.WebUI/) 
-- [WebExpress.WebApp API Documentation](https://reneschwarzer.github.io/WebExpress.WebApp/) 
-- [WebExpress.WebIndex API Documentation](https://reneschwarzer.github.io/WebExpress.WebIndex/) 
+- [Installation Guide](https://github.com/webexpress-framework/WebExpress/blob/main/doc/installation_guide.md) 
+- [Development Guide](https://github.com/webexpress-framework/WebExpress/blob/main/doc/development_guide.md)
+- [WebExpress.WebCore API Documentation](https://webexpress-framework.github.io/WebExpress.WebCore/) 
+- [WebExpress.WebUI API Documentation](https://webexpress-framework.github.io/WebExpress.WebUI/) 
+- [WebExpress.WebApp API Documentation](https://webexpress-framework.github.io/WebExpress.WebApp/) 
+- [WebExpress.WebIndex API Documentation](https://webexpress-framework.github.io/WebExpress.WebIndex/) 
 
 We hope you enjoy using `WebExpress.WebIndex` and find it valuable for your projects. Happy coding!

src/WebExpress.WebIndex.Test/DocumentStore/UnitTestDocumentStoreMemoryA.cs

@@ -55,6 +55,7 @@ public void Add()
 
             var i = documentStore.GetItem(Fixture.TestData[0].Id);
 
+            // validation
             Assert.True(i != null && i.Id == Fixture.TestData[0].Id);
 
             // postconditions
@@ -126,7 +127,7 @@ public void UpdateWithoutChanges()
         /// Removes an entry from the document store.
         /// </summary>
         [Fact]
-        public void Remove()
+        public void Delete()
         {
             // preconditions
             Preconditions();
@@ -140,7 +141,13 @@ public void Remove()
             documentStore.Delete(Fixture.TestData[0]);
             var all = documentStore.All;
 
-            Assert.Equal(all.Select(x => x.Id).OrderBy(x => x), Fixture.TestData.Where(x => x.Id == Fixture.TestData[1].Id).Select(x => x.Id));
+            Assert.Equal
+            (
+                all.Select(x => x.Id).OrderBy(x => x),
+                Fixture.TestData
+                    .Where(x => x.Id == Fixture.TestData[1].Id)
+                    .Select(x => x.Id)
+            );
 
             // postconditions
             documentStore.Dispose();