snap-admin/docs/index.html
2023-10-31 15:03:53 +01:00

122 lines
5.3 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SnapAdmin</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>
<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">
<body>
<!-- Top navbar -->
<nav class="navbar navbar-expand-lg navbar-light bg-light">
<div class="container">
<a class="navbar-brand" href="#"><img src="logo.png" style="width: 180px;"></a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarNav">
<ul class="navbar-nav ml-auto">
<li class="nav-item ms-2">
<a class="nav-link" href="#get-started"><i class="bi bi-github"></i> Github</a>
</li>
<li class="nav-item ms-2">
<a class="nav-link" href="#features">Features</a>
</li>
<li class="nav-item ms-2">
<a class="nav-link" href="https://aileftech.github.io/spring-boot-database-admin/index.html">Documentation</a>
</li>
</ul>
</div>
</div>
</nav>
<!-- Hero section -->
<header class="hero text-white text-center" style="background-color: #2F0F57;">
<div class="container p-5">
<h1 class="display-4 fw-bold">SnapAdmin</h1>
<p class="lead">A powerful, automatically-generated database management dashboard for Spring Boot/JPA applications</p>
<img src="screenshot.png" alt="Project Screenshot" class="img-fluid rounded">
<div class="mt-4">
<a href="#get-started" class="btn btn-light btn-lg">Get Started</a>
<a href="#install" class="btn btn-light btn-lg ms-3"><i class="bi bi-github"></i> Github</a>
</div>
</div>
</header>
<!-- Features section -->
<section id="features" class="py-5">
<div class="container">
<h2 class="text-center mb-4 fw-bold">Features</h2>
<div class="row">
<div class="col-md-4">
<h4 class="fw-bold">First-class CRUD</h4>
<p>Complete CRUD features for all entities and their associations, with out-of-the-box support for
JPA validation constraints and multiple field types.</p>
</div>
<div class="col-md-4">
<h4 class="fw-bold">Annotation-based customization</h4>
<p>Customize SnapAdmin by applying annotations to your objects, methods and fields. Create custom
columns to compute derived values.</p>
</div>
<div class="col-md-4">
<h4 class="fw-bold">Not just CRUD</h4>
<p>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>
</div>
</div>
<p>For a complete list of features read the Reference Guide</p>
</div>
</section>
<!-- Additional sections -->
<section id="get-started" class="py-5 bg-light">
<div class="container">
<h2 class="text-center mb-4 fw-bold">Get Started</h2>
<div class="row">
<div class="col-md-4">
<h4 class="fw-bold">Install Maven dependency</h4>
<pre>
<code>
&lt;dependency&gt;
&lt;groupId&gt;tech.ailef&lt;/groupId&gt;
&lt;artifactId&gt;spring-boot-db-admin&lt;/artifactId&gt;
&lt;version&gt;0.1.8&lt;/version&gt;
&lt;/dependency&gt;
</code>
</pre>
</div>
<div class="col-md-4">
<h4 class="fw-bold">Configure SnapAdmin</h4>
<pre>
<code>
dbadmin.baseUrl=admin
dbadmin.modelsPackage=your.models.package
</code>
</pre>
</div>
<div class="col-md-4">
<h4 class="fw-bold">Enable SnapAdmin</h4>
<pre>
<code>
@ImportAutoConfiguration(DbAdminAutoConfiguration.class)
</code>
</pre>
</div>
</div>
</div>
</section>
<!-- Footer -->
<footer class="footer text-white text-center text-lg-start" style="background-color: #130623;">
<div class="container p-4">
<p class="mt-2">&copy; 2023 SnapAdmin Panel. All rights reserved.</p>
<p>This is project is not affiliated or endorsed by the Spring foundation.</p>
</div>
</footer>
</body>
</html>