dalbodeule/snap-admin
1
0
Fork 0
mirror of https://github.com/dalbodeule/snap-admin.git synced 2025-06-09 05:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed references to old repo url

Browse Source
This commit is contained in:
Francesco 2023-11-02 18:36:20 +01:00
parent 84522842b3
commit 666dabc8c2
4 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -58,7 +58,7 @@ The code is still in a very early stage and it might not be robust if you use no
``` ```
2. A few simple configuration steps are required on your end in order to integrate the library into your project. 2. A few simple configuration steps are required on your end in order to integrate the library into your project.
If you don't want to test on your own code, you can clone the [test project](https://github.com/aileftech/spring-boot-database-admin-test) which provides If you don't want to test on your own code, you can clone the [test project](https://github.com/aileftech/snap-admin-test) which provides
a sample database and already configured code. a sample database and already configured code.
Otherwise, go ahead and add these to your `application.properties` file: Otherwise, go ahead and add these to your `application.properties` file:

14
docs/docs/index.html
View File

@ -34,7 +34,7 @@
<div class="collapse navbar-collapse" id="navbarSupportedContent"> <div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav me-auto mb-2 mb-lg-0"> <ul class="navbar-nav me-auto mb-2 mb-lg-0">
<li class="nav-item"> <li class="nav-item">
<a class="nav-link" href="https://github.com/aileftech/spring-boot-database-admin" target="_blank">Github</a> <a class="nav-link" href="https://github.com/aileftech/snap-admin" target="_blank">Github</a>
</li> </li>
</ul> </ul>
<!-- <!--
@ -67,7 +67,7 @@
<p>SnapAdmin is a tool to easily build customizable database management interfaces with CRUD operations (and more!) for Spring Boot+JPA apps.</p> <p>SnapAdmin is a tool to easily build customizable database management interfaces with CRUD operations (and more!) for Spring Boot+JPA apps.</p>
<p>It does so by scanning your JPA-annotated <code>@Entity</code> classes and building the required functionality at runtime. Since it won't generate actual code you won't have to change your existing code base, and this makes it easy to integrate. Moreover, every time you update your classes, all changes will be reflected automatically on the web UI. <p>It does so by scanning your JPA-annotated <code>@Entity</code> classes and building the required functionality at runtime. Since it won't generate actual code you won't have to change your existing code base, and this makes it easy to integrate. Moreover, every time you update your classes, all changes will be reflected automatically on the web UI.
</p> </p>
<p>On the other hand, this approach requires to interact correctly with all JPA annotations and adapt our behaviour accordingly. This is not an easy task given the large surface area of possible behaviours introduced with annotations and can sometimes introduce bugs. If you encounter problems, please <a href="https://github.com/aileftech/spring-boot-database-admin/issues" target="_blank">report it as an issue on Github</a>.</p> <p>On the other hand, this approach requires to interact correctly with all JPA annotations and adapt our behaviour accordingly. This is not an easy task given the large surface area of possible behaviours introduced with annotations and can sometimes introduce bugs. If you encounter problems, please <a href="https://github.com/aileftech/snap-admin/issues" target="_blank">report it as an issue on Github</a>.</p>
<p>The rest of this guide outlines how to install, configure and customize SnapAdmin and, where applicable, it documents known interactions with JPA annotations. If, instead, you are looking for the Javadoc, you can find it <a href="https://javadoc.io/doc/tech.ailef/snap-admin/latest/index.html">here</a>.</p> <p>The rest of this guide outlines how to install, configure and customize SnapAdmin and, where applicable, it documents known interactions with JPA annotations. If, instead, you are looking for the Javadoc, you can find it <a href="https://javadoc.io/doc/tech.ailef/snap-admin/latest/index.html">here</a>.</p>
<div class="separator"></div> <div class="separator"></div>
@ -81,12 +81,12 @@
<pre> <pre>
<code class="language-xml">&lt;dependency&gt; <code class="language-xml">&lt;dependency&gt;
&lt;groupId&gt;tech.ailef&lt;/groupId&gt; &lt;groupId&gt;tech.ailef&lt;/groupId&gt;
&lt;artifactId&gt;spring-boot-db-admin&lt;/artifactId&gt; &lt;artifactId&gt;snap-admin&lt;/artifactId&gt;
&lt;version&gt;0.1.9&lt;/version&gt; &lt;version&gt;0.1.9&lt;/version&gt;
&lt;/dependency&gt; &lt;/dependency&gt;
</code> </code>
</pre> </pre>
<p class="tip"><span class="title"><i class="bi bi-info-circle"></i> TIP</span> Go to the <a href="https://mvnrepository.com/artifact/tech.ailef/spring-boot-db-admin" target="_blank">Maven repository</a> to retrieve the exact snippet for the latest stable release.</p> <p class="tip"><span class="title"><i class="bi bi-info-circle"></i> TIP</span> Go to the <a href="https://mvnrepository.com/artifact/tech.ailef/snap-admin" target="_blank">Maven repository</a> to retrieve the exact snippet for the latest stable release.</p>
<p>Alternatively, if you want the latest unstable release, you can clone the <code>main</code> branch of the Github repo and execute <code>mvn install -D skipTests</code> in the project's directory. This will install the library in your local repository, which you can then include using the same snippet as above, but replacing the version number with the one contained in the <code>pom.xml</code> file of the code you pulled from Github.</p> <p>Alternatively, if you want the latest unstable release, you can clone the <code>main</code> branch of the Github repo and execute <code>mvn install -D skipTests</code> in the project's directory. This will install the library in your local repository, which you can then include using the same snippet as above, but replacing the version number with the one contained in the <code>pom.xml</code> file of the code you pulled from Github.</p>
@ -130,7 +130,7 @@ dbadmin.modelsPackage=your.models.package,your.second.models.package
<h4 id="known-issues">2.2.1 Known issues</h4> <h4 id="known-issues">2.2.1 Known issues</h4>
<ul> <ul>
<li><strong>(SnapAdmin <= 0.1.8) Transactional</strong>: If you're using <code>@Transactional</code> methods, you need to annotate your transaction manager with the <code>@Primary</code> annotation, as you may otherwise get a <code>NoUniqueBeanDefinitionException</code> (read <a href="https://github.com/aileftech/spring-boot-database-admin/issues/16" target="_blank">here</a> for more info). <li><strong>(SnapAdmin <= 0.1.8) Transactional</strong>: If you're using <code>@Transactional</code> methods, you need to annotate your transaction manager with the <code>@Primary</code> annotation, as you may otherwise get a <code>NoUniqueBeanDefinitionException</code> (read <a href="https://github.com/aileftech/snap-admin/issues/16" target="_blank">here</a> for more info).
</ul> </ul>
<h3 id="supported-features">2.3 Supported features</h3> <h3 id="supported-features">2.3 Supported features</h3>
@ -165,7 +165,7 @@ dbadmin.modelsPackage=your.models.package,your.second.models.package
<p>Unsupported field types are handled as gracefully as possible, meaning that when such a field is detected the application will still run. However, this field will never be displayed in the web interface. This means that it won't be possible to enter values for this field when editing or creating, leaving it with the default NULL value. If the field is not nullable, this implies you won't be able to create items.</p> <p>Unsupported field types are handled as gracefully as possible, meaning that when such a field is detected the application will still run. However, this field will never be displayed in the web interface. This means that it won't be possible to enter values for this field when editing or creating, leaving it with the default NULL value. If the field is not nullable, this implies you won't be able to create items.</p>
<p>If you're using a field type that you think should be supported, please <a href="https://github.com/aileftech/spring-boot-database-admin/issues" target="_blank">open an issue on Github</a>.</p> <p>If you're using a field type that you think should be supported, please <a href="https://github.com/aileftech/snap-admin/issues" target="_blank">open an issue on Github</a>.</p>
<p>To check if your code contains unsupported fields:</p> <p>To check if your code contains unsupported fields:</p>
<ul> <ul>
@ -371,7 +371,7 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
<p>When setting up SnapAdmin for the first time, problems most commonly occur at startup, causing the application to stop. If this is the case, first check that you have correctly configured your <code>application.properties</code> file. If everything is correct here, the problem might be related to one or more of your <code>@Entity</code> classes (or the rest of your code in general) which might be using some unsupported feature and/or annotation. </p> <p>When setting up SnapAdmin for the first time, problems most commonly occur at startup, causing the application to stop. If this is the case, first check that you have correctly configured your <code>application.properties</code> file. If everything is correct here, the problem might be related to one or more of your <code>@Entity</code> classes (or the rest of your code in general) which might be using some unsupported feature and/or annotation. </p>
<p> <p>
You can enable <code>DEBUG</code>-level logs (e.g. with <code>logging.level.root=DEBUG</code>) to pinpoint the cause error. Looking at those in combination with the stack trace should provide enough information to understand what is going wrong. Keep in mind that if the application doesn't start at all, it's probably a bug: you can <a href="https://github.com/aileftech/spring-boot-database-admin/issues" target="_blank">open an issue on Github</a>, providing the stacktrace, the debug logs and all other relevant information.</p> You can enable <code>DEBUG</code>-level logs (e.g. with <code>logging.level.root=DEBUG</code>) to pinpoint the cause error. Looking at those in combination with the stack trace should provide enough information to understand what is going wrong. Keep in mind that if the application doesn't start at all, it's probably a bug: you can <a href="https://github.com/aileftech/snap-admin/issues" target="_blank">open an issue on Github</a>, providing the stacktrace, the debug logs and all other relevant information.</p>
<div class="pt-3 pb-5"></div> <div class="pt-3 pb-5"></div>

20
docs/index.html
View File

@ -3,7 +3,7 @@
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SnapAdmin</title> <title>SnapAdmin &ndash; Spring Boot Database Admin Panel</title>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN" crossorigin="anonymous"></head> <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN" crossorigin="anonymous"></head>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-C6RzsynM9kWDrMNeT87bh95OGNyZPhcTNXj1NW7RuBCsyN/o0jlpcV8Qyq46cDfL" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-C6RzsynM9kWDrMNeT87bh95OGNyZPhcTNXj1NW7RuBCsyN/o0jlpcV8Qyq46cDfL" crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.2/font/bootstrap-icons.css" integrity="sha384-b6lVK+yci+bfDmaY1u0zE8YYJt0TZxLEAFyYSLHId4xoVvsrQu3INevFKo+Xir8e" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.2/font/bootstrap-icons.css" integrity="sha384-b6lVK+yci+bfDmaY1u0zE8YYJt0TZxLEAFyYSLHId4xoVvsrQu3INevFKo+Xir8e" crossorigin="anonymous">
@ -44,8 +44,8 @@
<header class="hero text-white text-center" style="background-color: #2F0F57;"> <header class="hero text-white text-center" style="background-color: #2F0F57;">
<div class="container p-5"> <div class="container p-5">
<h1 class="display-4 fw-bold">SnapAdmin</h1> <h1 class="display-4 fw-bold">SnapAdmin</h1>
<p class="lead">A powerful, automatically-generated database management dashboard for <a href="https://spring.io/projects/spring-boot/" class="text-white" target="_blank">Spring Boot&reg;</a>/JPA applications</p> <p class="lead">A powerful, automatically-generated database management panel for <a href="https://spring.io/projects/spring-boot/" class="text-white" target="_blank">Spring Boot&reg;</a>/JPA applications</p>
<img src="screenshot.png" alt="Project Screenshot" class="img-fluid rounded"> <img src="screenshot.png" alt="SnapAdmin screenshot showing the list view" class="img-fluid rounded">
<div class="mt-4"> <div class="mt-4">
<a href="#get-started" class="btn btn-light btn-lg">Get Started</a> <a href="#get-started" class="btn btn-light btn-lg">Get Started</a>
<a href="https://github.com/aileftech/snap-admin" class="btn btn-light btn-lg ms-3"><i class="bi bi-github"></i> Github</a> <a href="https://github.com/aileftech/snap-admin" class="btn btn-light btn-lg ms-3"><i class="bi bi-github"></i> Github</a>
@ -61,19 +61,19 @@
<div class="row pt-3"> <div class="row pt-3">
<div class="col-md-4"> <div class="col-md-4">
<h4 class="fw-bold">First-class CRUD</h4> <h4 class="fw-bold">First-class CRUD</h4>
<img src="img/crud.png" class="w-100 card-img"> <img src="img/crud.png" alt="SnapAdmin screenshot showing the editing form" class="w-100 card-img">
<p class="p-1 mt-2">Complete CRUD features for all entities and their associations, with out-of-the-box support for <p class="p-1 mt-2">Complete CRUD features for all entities and their associations, with out-of-the-box support for
JPA validation constraints and multiple field types.</p> JPA validation constraints and multiple field types.</p>
</div> </div>
<div class="col-md-4"> <div class="col-md-4">
<h4 class="fw-bold">Annotation-based customization</h4> <h4 class="fw-bold">Annotation-based customization</h4>
<img src="img/annotation.png" class="w-100 card-img"> <img src="img/annotation.png" alt="Screenshot showing some possible annotation-based customization" class="w-100 card-img">
<p class="p-1 mt-2">Customize SnapAdmin by applying annotations to your classes, methods and fields. You can apply custom <p class="p-1 mt-2">Customize SnapAdmin by applying annotations to your classes, methods and fields. You can apply custom
formatting and naming, create custom columns and more.</p> formatting and naming, create custom columns and more.</p>
</div> </div>
<div class="col-md-4"> <div class="col-md-4">
<h4 class="fw-bold">Not just CRUD</h4> <h4 class="fw-bold">Not just CRUD</h4>
<img src="img/export.png" class="w-100 card-img"> <img src="img/export.png" alt="SnapAdmin screenshot showing the export data dialog" class="w-100 card-img">
<p class="p-1 mt-2">With SnapAdmin you also get: audit logs for write operations, advanced filtering & search, <p class="p-1 mt-2">With SnapAdmin you also get: audit logs for write operations, advanced filtering & search,
data export (CSV, XLSX, JSONL) and an SQL console to run and save frequent queries.</p> data export (CSV, XLSX, JSONL) and an SQL console to run and save frequent queries.</p>
</div> </div>
@ -90,7 +90,9 @@
</p> </p>
<div class="row"> <div class="row">
<div class="col"> <div class="col">
<h3 class="fw-bold">1. Install Maven dependency</h3> <h3 class="fw-bold">1. Install Maven dependency</h3>
<p>SnapAdmin is distributed on Maven: just add the following to your <code>pom.xml</code> file.</p>
<pre class="language-xml"> <pre class="language-xml">
<code class="language-xml">&lt;dependency&gt; <code class="language-xml">&lt;dependency&gt;
&lt;groupId&gt;tech.ailef&lt;/groupId&gt; &lt;groupId&gt;tech.ailef&lt;/groupId&gt;
@ -104,8 +106,12 @@
<div class="row"> <div class="row">
<div class="col"> <div class="col">
<h3 class="fw-bold">2. Configure SnapAdmin</h3> <h3 class="fw-bold">2. Configure SnapAdmin</h3>
<p>Add the minimum required properties to your <code>application.properties</code> file.</p>
<pre> <pre>
<code class="language-properties">dbadmin.baseUrl=admin <code class="language-properties"># the root path of all SnapAdmin routes
dbadmin.baseUrl=admin
# comma-separated list of packages to scan for @Entity classes
dbadmin.modelsPackage=your.models.package dbadmin.modelsPackage=your.models.package
</code> </code>
</pre> </pre>

6
src/main/resources/templates/help.html
View File

@ -15,12 +15,12 @@
<span class="align-middle">Help</span></h3> <span class="align-middle">Help</span></h3>
<p class="mt-3"> <p class="mt-3">
If you need help using SnapAdmin, you can read the If you need help using SnapAdmin, you can read the
<a href="https://github.com/aileftech/spring-boot-database-admin">README</a> or the <a href="https://github.com/aileftech/snap-admin">README</a> or the
<a href="https://aileftech.github.io/spring-boot-database-admin/index.html">Reference Guide</a>. <a href="https://snapadmin.dev/docs">Reference Guide</a>.
</p> </p>
<p> <p>
If you don't find an answer to your question, feel free to ask with If you don't find an answer to your question, feel free to ask with
<a href="https://github.com/aileftech/spring-boot-database-admin/issues">an issue on Github</a>.</p> <a href="https://github.com/aileftech/snap-admin/issues">an issue on Github</a>.</p>
</div> </div>
</div> </div>
</div> </div>