Started working on documentation
This commit is contained in:
3
docs/Writerside/topics/Callbacks.md
Normal file
3
docs/Writerside/topics/Callbacks.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Callbacks
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/CreateEntityEvent.md
Normal file
3
docs/Writerside/topics/CreateEntityEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# CreateEntityEvent
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/Dashboard.md
Normal file
3
docs/Writerside/topics/Dashboard.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Dashboard
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/DbContextConfig.md
Normal file
3
docs/Writerside/topics/DbContextConfig.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# DbContextConfig
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/DeleteEntityEvent.md
Normal file
3
docs/Writerside/topics/DeleteEntityEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# DeleteEntityEvent
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/Events.md
Normal file
3
docs/Writerside/topics/Events.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Events
|
||||
|
||||
Start typing here...
|
||||
2
docs/Writerside/topics/HopFrameConfig.md
Normal file
2
docs/Writerside/topics/HopFrameConfig.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# HopFrameConfig
|
||||
|
||||
31
docs/Writerside/topics/Installation.md
Normal file
31
docs/Writerside/topics/Installation.md
Normal file
@@ -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<DatabaseContext>();
|
||||
});
|
||||
```
|
||||
|
||||
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.
|
||||
3
docs/Writerside/topics/PageChangeEvent.md
Normal file
3
docs/Writerside/topics/PageChangeEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# PageChangeEvent
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/Plugins.md
Normal file
3
docs/Writerside/topics/Plugins.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Plugins
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/PropertyConfig.md
Normal file
3
docs/Writerside/topics/PropertyConfig.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# PropertyConfig
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/ReloadEvent.md
Normal file
3
docs/Writerside/topics/ReloadEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# ReloadEvent
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/SearchEvent.md
Normal file
3
docs/Writerside/topics/SearchEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# SearchEvent
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/SelectEntityEvent.md
Normal file
3
docs/Writerside/topics/SelectEntityEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# SelectEntityEvent
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/Table.md
Normal file
3
docs/Writerside/topics/Table.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Table
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/TableConfig.md
Normal file
3
docs/Writerside/topics/TableConfig.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# TableConfig
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/TableInitializedEvent.md
Normal file
3
docs/Writerside/topics/TableInitializedEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# TableInitializedEvent
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/UpdateEntityEvent.md
Normal file
3
docs/Writerside/topics/UpdateEntityEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# UpdateEntityEvent
|
||||
|
||||
Start typing here...
|
||||
3
docs/Writerside/topics/ValidationEvent.md
Normal file
3
docs/Writerside/topics/ValidationEvent.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# ValidationEvent
|
||||
|
||||
Start typing here...
|
||||
14
docs/Writerside/topics/starter.md
Normal file
14
docs/Writerside/topics/starter.md
Normal file
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user