README

A simple and customizable system for managing submissions. Designed for Laravel applications, it offers essential tools to streamline submission processes with minimal setup.

Installation

Step 1: Install the Package

composer require al-rimi/submit

Step 2: Run the Installation Command

php artisan submit:install

Features

• Submission Management: Collect, validate, and store student submissions effectively.
• Email Notifications: Rreceive notifications after each submission.
• Dynamic Table Management: Displays and updates student submissions dynamically without page reloads.
• Auto-fill: Custom JS script for client side auto fill.
• UI: vanilla CSS with simple animations and clean look..

Customization

Environment Variables

To enable submission notifications and set a deadline, add the following variables to your .env file:

NOTIFICATION_EMAIL=      # Email address to receive submission notifications  
SUBMISSION_DEADLINE=     # Submission deadline in ISO 8601 format (e.g., "YYYY-MM-DDTHH:MM:SS")  

Routes

The package publishes its routes to routes/submit.php. You can customize these routes to:

• Change view paths.
• Add middleware for additional security or access control.

Views

All customizable views are published to your project for easy modification:

• Submission Page: resources/views/submissions.blade.php
• Email Template: resources/views/emails/submissions_email.blade.php

CSS and JavaScript

dependency-free assets for styling and interactivity in vanilla CSS and JavaScript:

• CSS File: resources/css/submit.css
• JavaScript File: resources/js/submit.js

Database

The package provides database migrations and a sample seeder to kickstart your setup:

• Migrations: Automatically created tables for submission data.
• Seeder: database/Seeders/StudentsTableSeeder.php populates the database with example records.

Troubleshooting

export default defineConfig({
    input: [
        'resources/css/app.css',
        'resources/js/app.js',
        'resources/css/submit.css',
        'resources/js/submit.js'
    ],
    // other Vite configuration
});

npm install
npm run build

Uninstallation

Step 1: Remove all traces of the Submit package:

php artisan submit:uninstall

Step 2: remove the package:

composer remove al-rimi/submit

Requirements

• PHP 8.0 or higher
• Laravel 10.x or 11.x
• Node.js (for Vite asset compilation)

Have questions or facing issues? Check out the issues page.

License

This package is open-source and is licensed under the MIT License.