README

DK E-Signer is a Laravel package that provides a simple and flexible way to integrate e-signatures into your application. It allows users to draw or type their signatures and stores them securely.

Features

Signature Capture: Supports drawing and typing signatures.
Signature Storage: Stores signatures as data URLs or files.
Document Type Management: Define different document types and associated signature fields.
Customizable: Easily extendable to fit your application's needs.

Installation

You can install the package via composer:

composer require dekate/esigner

Configuration

Publish the configuration file using the following command:

php artisan vendor:publish --provider="Dekate\\Esigner\\Providers\\CanvasSignerServiceProvider" --tag="dk_signer:config"

This will publish config/dk_signer.php where you can configure settings such as storage disk, encryption key, and route prefix.

Migrations

Run the migrations to create the necessary tables for document types and signatures:

php artisan migrate

Publishing Assets

Publish the package's public assets (CSS and JavaScript files), run the following command:

php artisan vendor:publish --provider="Dekate\Esigner\Providers\CanvasSignerServiceProvider" --tag="dk_signer:public"

Important: The frontend components of this package (e.g., signature pads, styling) will not function correctly without these assets being published. Ensure this command is run after installation and during deployment.

This will copy the compiled dk_signer.css and dk_signer.js files to public/vendor/dk_signer.

Usage

Routes

The package registers the following routes:

/dk_signer (configurable via dk_signer.route_prefix in config/dk_signer.php)
- GET /dk_signer: Displays the signature pad for creating new signatures.
- POST /dk_signer: Handles the submission of signatures.
- GET /dk_signer/type: Displays the form for managing signature types.
- POST /dk_signer/type: Handles the creation of new signature types.

dekate / esigner

Maintainers

Details