README.md

Guestbook

The Guestbook project is a web application built using Laravel, Tw-Elements, and TailwindCSS for efficient guest management.

Table of Contents

• Installation
• Usage
• Features
• Contributing
• License
• Contact

Installation

Prerequisites

Make sure you have the following installed:

• PHP (v8 or higher)
• Node.js (v18 or higher)
• Composer (v2 or higher)
• Laragon / XAMPP
• PHP extensions (ensure enabled in php.ini):
  • zip
  • gd

Steps to install

1. Clone the repository:

   git clone https://github.com/memiljamel/project-guest-book.git

2. Navigate to the project directory:

   cd project-guest-book

3. Install dependencies.

   • For Laravel/PHP projects:

     composer install

   • For Node.js projects:

     npm install

4. Set up environment variables:

   cp .env.example .env

   Edit the .env file with the necessary configuration values (database, environment, etc.).

5. Generate application key:

   php artisan key:generate

6. Run database migrations:

   php artisan migrate

7. Seed the database with initial data (optional):

   php artisan db:seed

8. Start the development server.

   • For Laravel projects:

     php artisan serve

   • For Node.js projects:

     npm run dev

Usage

After completing the installation steps and the server is running, open your browser and navigate to http://localhost:8000.

Features

• Guest Registration: Allows guests to register their information, including name, contact details, and visit purpose.
• Create Feedback: Enables guests to submit feedback about their visit or experience.
• Authentication: Provides login, password recovery, and reset functionalities for administrators.
• Dashboard: Overview of recent guest activity.
• Manage Guests: Enables administrators to view, create, edit, and delete guest information.
• Manage Staffs: Enables administrators to view, create, edit, and delete staff information.
• Manage Department: Enables administrators to view, create, edit, and delete department information.
• Manage Feedbacks: Enables administrators to view, create, edit, and delete feedback information.
• Search Functionality: Enables searching for specific records.
• Data Export: Supports exporting data to PDF, Excel, and CSV formats.
• Edit Profile: Enables administrators to update their profile information.

Contributing

Feel free to contribute to this project by submitting pull requests or reporting issues.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

• Email: memiljamel@gmail.com
• LinkedIn: linkedin.com/in/memiljamel
• GitHub: github.com/memiljamel