From 47f30bf33ffeebf02be792ed6b2dc5e0dae3ab67 Mon Sep 17 00:00:00 2001 From: Leon Hoppe Date: Tue, 11 Feb 2025 20:52:52 +0100 Subject: [PATCH 1/4] Started working on documentation --- .idea/.idea.HopFrame/.idea/workspace.xml | 77 +++++++++++-------- docs/.idea/.gitignore | 3 + docs/.idea/docs.iml | 8 ++ docs/.idea/modules.xml | 8 ++ docs/.idea/vcs.xml | 6 ++ docs/Writerside/c.list | 6 ++ docs/Writerside/cfg/buildprofiles.xml | 13 ++++ docs/Writerside/cfg/glossary.xml | 7 ++ docs/Writerside/hopframe.tree | 39 ++++++++++ docs/Writerside/topics/Callbacks.md | 3 + docs/Writerside/topics/CreateEntityEvent.md | 3 + docs/Writerside/topics/Dashboard.md | 3 + docs/Writerside/topics/DbContextConfig.md | 3 + docs/Writerside/topics/DeleteEntityEvent.md | 3 + docs/Writerside/topics/Events.md | 3 + docs/Writerside/topics/HopFrameConfig.md | 2 + docs/Writerside/topics/Installation.md | 31 ++++++++ docs/Writerside/topics/PageChangeEvent.md | 3 + docs/Writerside/topics/Plugins.md | 3 + docs/Writerside/topics/PropertyConfig.md | 3 + docs/Writerside/topics/ReloadEvent.md | 3 + docs/Writerside/topics/SearchEvent.md | 3 + docs/Writerside/topics/SelectEntityEvent.md | 3 + docs/Writerside/topics/Table.md | 3 + docs/Writerside/topics/TableConfig.md | 3 + .../topics/TableInitializedEvent.md | 3 + docs/Writerside/topics/UpdateEntityEvent.md | 3 + docs/Writerside/topics/ValidationEvent.md | 3 + docs/Writerside/topics/starter.md | 14 ++++ docs/Writerside/v.list | 5 ++ docs/Writerside/writerside.cfg | 11 +++ 31 files changed, 251 insertions(+), 30 deletions(-) create mode 100644 docs/.idea/.gitignore create mode 100644 docs/.idea/docs.iml create mode 100644 docs/.idea/modules.xml create mode 100644 docs/.idea/vcs.xml create mode 100644 docs/Writerside/c.list create mode 100644 docs/Writerside/cfg/buildprofiles.xml create mode 100644 docs/Writerside/cfg/glossary.xml create mode 100644 docs/Writerside/hopframe.tree create mode 100644 docs/Writerside/topics/Callbacks.md create mode 100644 docs/Writerside/topics/CreateEntityEvent.md create mode 100644 docs/Writerside/topics/Dashboard.md create mode 100644 docs/Writerside/topics/DbContextConfig.md create mode 100644 docs/Writerside/topics/DeleteEntityEvent.md create mode 100644 docs/Writerside/topics/Events.md create mode 100644 docs/Writerside/topics/HopFrameConfig.md create mode 100644 docs/Writerside/topics/Installation.md create mode 100644 docs/Writerside/topics/PageChangeEvent.md create mode 100644 docs/Writerside/topics/Plugins.md create mode 100644 docs/Writerside/topics/PropertyConfig.md create mode 100644 docs/Writerside/topics/ReloadEvent.md create mode 100644 docs/Writerside/topics/SearchEvent.md create mode 100644 docs/Writerside/topics/SelectEntityEvent.md create mode 100644 docs/Writerside/topics/Table.md create mode 100644 docs/Writerside/topics/TableConfig.md create mode 100644 docs/Writerside/topics/TableInitializedEvent.md create mode 100644 docs/Writerside/topics/UpdateEntityEvent.md create mode 100644 docs/Writerside/topics/ValidationEvent.md create mode 100644 docs/Writerside/topics/starter.md create mode 100644 docs/Writerside/v.list create mode 100644 docs/Writerside/writerside.cfg diff --git a/.idea/.idea.HopFrame/.idea/workspace.xml b/.idea/.idea.HopFrame/.idea/workspace.xml index a12d024..f94df67 100644 --- a/.idea/.idea.HopFrame/.idea/workspace.xml +++ b/.idea/.idea.HopFrame/.idea/workspace.xml @@ -12,11 +12,19 @@ - + + + + + + + + + + + + - - - {} { @@ -118,28 +126,28 @@ - { - "keyToString": { - ".NET Launch Settings Profile.HopFrame.Testing.Api: https.executor": "Run", - ".NET Launch Settings Profile.HopFrame.Testing.executor": "Run", - ".NET Launch Settings Profile.HopFrame.Testing: https.executor": "Run", - ".NET Project.HopFrame.Testing.executor": "Run", - "72b118b0-a6fc-4561-acdf-74f0b454dbb8.executor": "Debug", - "RunOnceActivity.ShowReadmeOnStart": "true", - "RunOnceActivity.git.unshallow": "true", - "b5f11219-dfc4-47a1-b02c-90ab603034fb.executor": "Debug", - "dcdf1689-dc07-47e4-8824-2e60a4fbf301.executor": "Debug", - "git-widget-placeholder": "dev", - "list.type.of.created.stylesheet": "CSS", - "node.js.detected.package.eslint": "true", - "node.js.detected.package.tslint": "true", - "node.js.selected.package.eslint": "(autodetect)", - "node.js.selected.package.tslint": "(autodetect)", - "nodejs_package_manager_path": "npm", - "settings.editor.selected.configurable": "preferences.environmentSetup", - "vue.rearranger.settings.migration": "true" + +}]]> @@ -617,7 +634,6 @@ \ No newline at end of file diff --git a/docs/.idea/.gitignore b/docs/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/docs/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/docs/.idea/docs.iml b/docs/.idea/docs.iml new file mode 100644 index 0000000..6102194 --- /dev/null +++ b/docs/.idea/docs.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/.idea/modules.xml b/docs/.idea/modules.xml new file mode 100644 index 0000000..6049cfe --- /dev/null +++ b/docs/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/docs/.idea/vcs.xml b/docs/.idea/vcs.xml new file mode 100644 index 0000000..6c0b863 --- /dev/null +++ b/docs/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/Writerside/c.list b/docs/Writerside/c.list new file mode 100644 index 0000000..c4c77a2 --- /dev/null +++ b/docs/Writerside/c.list @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/docs/Writerside/cfg/buildprofiles.xml b/docs/Writerside/cfg/buildprofiles.xml new file mode 100644 index 0000000..9b254c1 --- /dev/null +++ b/docs/Writerside/cfg/buildprofiles.xml @@ -0,0 +1,13 @@ + + + + + + + + false + + + + diff --git a/docs/Writerside/cfg/glossary.xml b/docs/Writerside/cfg/glossary.xml new file mode 100644 index 0000000..22bec6b --- /dev/null +++ b/docs/Writerside/cfg/glossary.xml @@ -0,0 +1,7 @@ + + + + + Description of what "foo" is. + + \ No newline at end of file diff --git a/docs/Writerside/hopframe.tree b/docs/Writerside/hopframe.tree new file mode 100644 index 0000000..1e0a23a --- /dev/null +++ b/docs/Writerside/hopframe.tree @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Writerside/topics/Callbacks.md b/docs/Writerside/topics/Callbacks.md new file mode 100644 index 0000000..700d0fb --- /dev/null +++ b/docs/Writerside/topics/Callbacks.md @@ -0,0 +1,3 @@ +# Callbacks + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/CreateEntityEvent.md b/docs/Writerside/topics/CreateEntityEvent.md new file mode 100644 index 0000000..6e5b747 --- /dev/null +++ b/docs/Writerside/topics/CreateEntityEvent.md @@ -0,0 +1,3 @@ +# CreateEntityEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/Dashboard.md b/docs/Writerside/topics/Dashboard.md new file mode 100644 index 0000000..05a7784 --- /dev/null +++ b/docs/Writerside/topics/Dashboard.md @@ -0,0 +1,3 @@ +# Dashboard + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/DbContextConfig.md b/docs/Writerside/topics/DbContextConfig.md new file mode 100644 index 0000000..0e4d021 --- /dev/null +++ b/docs/Writerside/topics/DbContextConfig.md @@ -0,0 +1,3 @@ +# DbContextConfig + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/DeleteEntityEvent.md b/docs/Writerside/topics/DeleteEntityEvent.md new file mode 100644 index 0000000..5229501 --- /dev/null +++ b/docs/Writerside/topics/DeleteEntityEvent.md @@ -0,0 +1,3 @@ +# DeleteEntityEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/Events.md b/docs/Writerside/topics/Events.md new file mode 100644 index 0000000..3f7c8f3 --- /dev/null +++ b/docs/Writerside/topics/Events.md @@ -0,0 +1,3 @@ +# Events + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/HopFrameConfig.md b/docs/Writerside/topics/HopFrameConfig.md new file mode 100644 index 0000000..5f4dc7c --- /dev/null +++ b/docs/Writerside/topics/HopFrameConfig.md @@ -0,0 +1,2 @@ +# HopFrameConfig + diff --git a/docs/Writerside/topics/Installation.md b/docs/Writerside/topics/Installation.md new file mode 100644 index 0000000..26203d3 --- /dev/null +++ b/docs/Writerside/topics/Installation.md @@ -0,0 +1,31 @@ +# Installation + +Install the nuget package using the CLI or the UI of your IDE: + +```bash +dotnet add package HopFrame.Web +``` + +## Minimal configuration + +Configuring HopFrame is straightforward and flexible. You can easily define your contexts, tables, and their properties using the provided configurators. +Simply use your editors intelli-sense to find out what you can configure. + + +```c# +builder.Services.AddHopFrame(options => { + options.AddDbContext(); +}); +``` + +Then you need to map the frontend pages in your application: + +```c# +app.MapHopFrame(); +``` + +## Usage + +- Navigate to `/admin` to access the admin dashboard and start managing your tables. +- Use the side menu to switch between different tables. +- Utilize the built-in CRUD functionality to manage your data seamlessly. diff --git a/docs/Writerside/topics/PageChangeEvent.md b/docs/Writerside/topics/PageChangeEvent.md new file mode 100644 index 0000000..e1b898c --- /dev/null +++ b/docs/Writerside/topics/PageChangeEvent.md @@ -0,0 +1,3 @@ +# PageChangeEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/Plugins.md b/docs/Writerside/topics/Plugins.md new file mode 100644 index 0000000..cdf0c51 --- /dev/null +++ b/docs/Writerside/topics/Plugins.md @@ -0,0 +1,3 @@ +# Plugins + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/PropertyConfig.md b/docs/Writerside/topics/PropertyConfig.md new file mode 100644 index 0000000..c59e369 --- /dev/null +++ b/docs/Writerside/topics/PropertyConfig.md @@ -0,0 +1,3 @@ +# PropertyConfig + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/ReloadEvent.md b/docs/Writerside/topics/ReloadEvent.md new file mode 100644 index 0000000..c26c3d5 --- /dev/null +++ b/docs/Writerside/topics/ReloadEvent.md @@ -0,0 +1,3 @@ +# ReloadEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/SearchEvent.md b/docs/Writerside/topics/SearchEvent.md new file mode 100644 index 0000000..3d2bb04 --- /dev/null +++ b/docs/Writerside/topics/SearchEvent.md @@ -0,0 +1,3 @@ +# SearchEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/SelectEntityEvent.md b/docs/Writerside/topics/SelectEntityEvent.md new file mode 100644 index 0000000..d93af02 --- /dev/null +++ b/docs/Writerside/topics/SelectEntityEvent.md @@ -0,0 +1,3 @@ +# SelectEntityEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/Table.md b/docs/Writerside/topics/Table.md new file mode 100644 index 0000000..7f1ef1f --- /dev/null +++ b/docs/Writerside/topics/Table.md @@ -0,0 +1,3 @@ +# Table + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/TableConfig.md b/docs/Writerside/topics/TableConfig.md new file mode 100644 index 0000000..a7ebe7d --- /dev/null +++ b/docs/Writerside/topics/TableConfig.md @@ -0,0 +1,3 @@ +# TableConfig + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/TableInitializedEvent.md b/docs/Writerside/topics/TableInitializedEvent.md new file mode 100644 index 0000000..02b205b --- /dev/null +++ b/docs/Writerside/topics/TableInitializedEvent.md @@ -0,0 +1,3 @@ +# TableInitializedEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/UpdateEntityEvent.md b/docs/Writerside/topics/UpdateEntityEvent.md new file mode 100644 index 0000000..745fcf6 --- /dev/null +++ b/docs/Writerside/topics/UpdateEntityEvent.md @@ -0,0 +1,3 @@ +# UpdateEntityEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/ValidationEvent.md b/docs/Writerside/topics/ValidationEvent.md new file mode 100644 index 0000000..f5563a3 --- /dev/null +++ b/docs/Writerside/topics/ValidationEvent.md @@ -0,0 +1,3 @@ +# ValidationEvent + +Start typing here... \ No newline at end of file diff --git a/docs/Writerside/topics/starter.md b/docs/Writerside/topics/starter.md new file mode 100644 index 0000000..c00780e --- /dev/null +++ b/docs/Writerside/topics/starter.md @@ -0,0 +1,14 @@ +# Overview + +Welcome to the HopFrame! This project aims to provide a comprehensive and modular framework for easy management of your database. +The framework is designed to be highly configurable, ensuring that developers either quickly add the framework for simple data editing or +configure it to their needs to implement it fully in their data management pipeline. + +## Features + +- **Dynamic Table Management**: Create, edit, and delete records dynamically with support for various data types including numeric, text, boolean, dates, and relational data. +- **Role-Based Access Control (RBAC)**: Implement fine-grained access control policies for viewing, creating, updating, and deleting records. +- **Modern Design**: A modern and user-friendly interface built with Fluent UI components, ensuring easy to use and pleasing administration pages. +- **Validation and Error Handling**: Comprehensive input validation and error handling to ensure data integrity and provide feedback to users. +- **Support for Complex Data Relationships**: Manage complex relationships between data entities with ease. + diff --git a/docs/Writerside/v.list b/docs/Writerside/v.list new file mode 100644 index 0000000..2d12cb3 --- /dev/null +++ b/docs/Writerside/v.list @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/Writerside/writerside.cfg b/docs/Writerside/writerside.cfg new file mode 100644 index 0000000..bf534b9 --- /dev/null +++ b/docs/Writerside/writerside.cfg @@ -0,0 +1,11 @@ + + + + + + + + + + \ No newline at end of file From 08d4ddb2c6f99c1250c4566168b438cb715bdc3a Mon Sep 17 00:00:00 2001 From: Leon Hoppe Date: Wed, 12 Feb 2025 11:19:34 +0100 Subject: [PATCH 2/4] Added documentation for the core module --- .idea/.idea.HopFrame/.idea/workspace.xml | 61 +++-- docs/Writerside/topics/Callbacks.md | 30 ++- docs/Writerside/topics/DbContextConfig.md | 37 ++- docs/Writerside/topics/HopFrameConfig.md | 157 ++++++++++++ docs/Writerside/topics/PropertyConfig.md | 285 +++++++++++++++++++++- docs/Writerside/topics/TableConfig.md | 190 ++++++++++++++- 6 files changed, 723 insertions(+), 37 deletions(-) diff --git a/.idea/.idea.HopFrame/.idea/workspace.xml b/.idea/.idea.HopFrame/.idea/workspace.xml index f94df67..0444ede 100644 --- a/.idea/.idea.HopFrame/.idea/workspace.xml +++ b/.idea/.idea.HopFrame/.idea/workspace.xml @@ -12,19 +12,13 @@ - - - - - - - - - - - - + + + + + + - { + "keyToString": { + ".NET Launch Settings Profile.HopFrame.Testing.Api: https.executor": "Run", + ".NET Launch Settings Profile.HopFrame.Testing.executor": "Run", + ".NET Launch Settings Profile.HopFrame.Testing: https.executor": "Run", + ".NET Project.HopFrame.Testing.executor": "Run", + "72b118b0-a6fc-4561-acdf-74f0b454dbb8.executor": "Debug", + "RunOnceActivity.ShowReadmeOnStart": "true", + "RunOnceActivity.git.unshallow": "true", + "b5f11219-dfc4-47a1-b02c-90ab603034fb.executor": "Debug", + "dcdf1689-dc07-47e4-8824-2e60a4fbf301.executor": "Debug", + "git-widget-placeholder": "!31 on feature/docs", + "list.type.of.created.stylesheet": "CSS", + "node.js.detected.package.eslint": "true", + "node.js.detected.package.tslint": "true", + "node.js.selected.package.eslint": "(autodetect)", + "node.js.selected.package.tslint": "(autodetect)", + "nodejs_package_manager_path": "npm", + "settings.editor.selected.configurable": "preferences.pluginManager", + "vue.rearranger.settings.migration": "true" } -}]]> +} + + + + - - - - - + + +