Skip to content

JaberWiki/invite-system

Repository files navigation

Laravel Invitation management system

Author: Mohammad Jaber

Features:

User can register and invite other user by invitaion code.

  • Used Laravel Breeze for Authentication.
  • Used middelware for active user.
  • Create an invition code followed by validation rules.
  • Cheack if the Invite Code is expired.
  • Listing a Invition Code.
  • User can request for Invite Code.
  • User can request Invite Code within a spacific limit.
  • User can also check when did they requested for Invite Code.
  • User can check how many time his invite code used.
  • Blcok the code usage after a certain limit of that code usage.

Validation rules:

  • Check if user is active.
  • Check if code is valide.
  • Check the code expiration date.
  • Check how many invition code usage remaining.
  • Check if code usage limit.

Installation Guide

Follow these steps to set up and run the project locally.

Prerequisites

Make sure you have the following installed:

  • Git
  • Composer
  • PHP >= 8.*
  • MySQL
  • Laravel 9.*

Installation Steps

  1. Clone the GitHub repository

    git clone https://github.com/JaberWiki/invite-system.git
    
  2. Install Composer packages:

    composer install
    
  3. Create .env file

    Duplicate .env.example and rename it to .env.

    or

    cp .env.example .env
  4. Generate encryption key

    Run the following command to generate a unique application key.

    php artisan key:generate
    
  5. Run migrations

    php artisan migrate
    
  6. Add Invite code limit in .env

    MAX_INVITE_CODE_LIMIT
    
  7. Start the development server

    php artisan serve
    
    

Contributor

License

This Project is open-sourced software licensed under the MIT license.