Skip to content

Latest commit

 

History

History
161 lines (118 loc) · 4.48 KB

README.md

File metadata and controls

161 lines (118 loc) · 4.48 KB

PROJECT_SIGNEASE 🌟

License: MIT PHP Version MySQL Version

PROJECT_SIGNEASE is a web application designed to streamline document sharing and management for digital signatures. Simplify your signing process with a secure, intuitive platform.

SignEase Demo

Table of Contents

🚀 Features

  • Document Upload & Sharing: Securely upload and share documents for digital signatures.
  • User Authentication: Role-based access control for document management.
  • Signature Tracking: Real-time tracking of document signing status.
  • Responsive Design: Mobile-friendly interface using TailwindCSS.
  • Audit Trail: Maintains history of document interactions.
  • PDF Support: Optimized handling of PDF documents.

💻 Tech Stack

Frontend
HTML5 TailwindCSS JavaScript

Backend
PHP MySQL

Tools
Composer Git

📥 Installation

  1. Clone the repository
git clone https://github.com/SandunLB/Project_Signease.git
cd PROJECT_SIGNEASE
  1. Set up the database
CREATE DATABASE Project_signease;
USE Project_signease;
-- Import SQL file from database/Project_signease.sql
  1. Configure settings Update config.php with your database credentials:
DB_HOST=localhost
DB_NAME=signease_db
DB_USER=root
DB_PASS=your_password
  1. Start the PHP server
php -S localhost:8000

🖥️ Usage

  1. Access the application

    • If using XAMPP: Visit http://localhost/Project_Signease in your browser
    • If using PHP built-in server: Visit http://localhost:8000 in your browser

  2. Upload Documents

    • Navigate to Dashboard
    • Click Upload New Document
    • Select PDF/document and add signer emails

  3. Track Signatures

    • Monitor signing progress in real-time
    • Receive notifications when documents are signed

  4. Download Signed Documents

    • Completed documents are automatically archived
    • Available in both PDF and audit log formats

🔧Configuration

Email Setup

Configure SMTP in config/mail.php for email notifications:

define('SMTP_HOST', 'smtp.example.com');
define('SMTP_PORT', 587);
define('SMTP_USER', 'user@example.com');
define('SMTP_PASS', 'password');

Security Settings

Update config/security.php for enhanced protection:

// Enable HTTPS redirection
define('FORCE_HTTPS', true);

// Session encryption
define('SESSION_ENCRYPTION_KEY', 'your-secure-key-here');

🤝 Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
  3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
  4. Push to the branch (`git push origin feature/AmazingFeature`)
  5. Open a Pull Request

Development Guidelines

  • Follow PSR-12 coding standards
  • Write unit tests for new features
  • Update documentation accordingly

📄 License

Distributed under the MIT License. See `LICENSE` file for more information.

🙏 Acknowledgements

📧 Contact

Project Maintainer
[Your Name] - sandunlb2001@gmail.com
GitHub: @SandunLB

Project Link: https://github.com/SandunLB/Project_Signease