updated readme and docs

This commit is contained in:
giandonato.inverso@edempg.it
2025-01-21 22:41:14 +01:00
parent b4b42ddb29
commit 737ceca97b
2 changed files with 7 additions and 11 deletions
+7 -10
View File
@@ -2,7 +2,11 @@
**PHP Dynamic Qr code** is a script that allows the generation and saving of dynamic and static QR codes. It has a clean, responsive, and user-friendly design. It is based on [AdminLte](https://adminlte.io/), the "Best open source admin dashboard & control panel theme. Built on top of Bootstrap" and [Core PHP Admin Panel](https://github.com/chetans9/core-php-admin-panel), a simple Admin Panel written in core PHP that contains an implementation of general features you might need in your website admin panel like: record management (CRUD), secure authentication, pagination, filters.
[LIVE DEMO](https://giandonatoinverso.it/qrcode)
[LIVE DEMO](https://vps-51f5a38d.vps.ovh.net/)
username: admin
password: admin
[DOCUMENTATION](https://giandonatoinverso.it/qrcode/documentation)
@@ -14,7 +18,6 @@ contact me at hello@giandonatoinverso.dev for installations, custom implementati
- **#1 Dynamic Qr code generator on GitHub with a database to store Qr codes**
- Create unlimited Qr codes
- Easy installation wizard
- Docker compose support
- Control panel with 2 access levels
- Multi-account
@@ -49,8 +52,6 @@ contact me at hello@giandonatoinverso.dev for installations, custom implementati
- Easy to understand and expand code
- Full OOP with classes and well-documented
The project requires at least PHP 7.4 to run properly. It has been successfully tested up to PHP 8.1.
## What is included
- PHP files
@@ -59,7 +60,7 @@ The project requires at least PHP 7.4 to run properly. It has been successfully
- CSS files
- Docker compose file
## Setup with docker compose (simplest method)
## Setup with docker compose
1. download docker-compose.yml file
2. Start docker stack
```bash
@@ -67,12 +68,9 @@ docker compose build --no-cache && docker compose up -d
```
3. Open your browser at http://localhost:80 and login with (username: superadmin, password: superadmin)
For other setup methods please see the documentation
# Available plugins
# Available non open source plugins
## QrRole
Manage user privileges with multi-level access control:
- *Creator*: can only create and delete your own qrcodes
@@ -86,7 +84,6 @@ Unlock advanced customization features for QR codes, including logo uploads, wat
Save time by creating reusable templates for generating QR codes with predefined styles and settings.
## QrBulk
- Create static or dynamic QR codes in bulk by compiling an Excel file with the QR code data and uploading it to the site. Inside the file it is possible to specify, if necessary, an already existing QrTemplate template. After creation you will be able to download a zip file with the QR codes created and the same Excel file but with the redirect identifier added
- Create dynamic QR codes in bulk by choosing the desired number, so you can download a zip file with the created QR codes, Excel files so you can print them. At a later time you can modify the URLs associated with the QR codes created
-1
View File
@@ -80,7 +80,6 @@
<div id="setup">
<h2> Setup</h2>
<p>You can choose between local installation (recommended for development) and docker installation (recommended for general use)</p>
<p><u>Local setup:</u></p>
<ol><strong>
<li>No more available from v2.3.0</li>