Everifi

Everifi is a web application designed to manage user profiles, allowing users to update their profile picture, name, email, and password. It also includes email confirmation functionality for secure account management. Built with Laravel Breeze and the Blade with Alpine.js stack, Everifi provides a seamless and intuitive user experience for profile management and email verification.

This project is ideal for programmers interested in exploring Laravel-based web applications, profile management systems, or contributing to an open-source project.

---

Setup Instructions for Windows

To set up Everifi on your local machine, follow these steps. This guide assumes you are using XAMPP (Apache and MySQL) as your local server environment and Mailtrap for email testing.

---

Step 1: Set Up Mailtrap for Email Testing

1. Go to Mailtrap and create or log in to your account.
2. Open the sidebar and navigate to Email Testing.
3. Create a new inbox or open an existing one.
4. In desktop view, ensure you are on the Integration tab on the right side of the page.
5. Scroll down and select the PHP dropdown.
6. Choose Laravel 9+ and click the Copy button at the far right. Save this information for later use.

---

Step 2: Install XAMPP and Start Apache and MySQL

1. Download and install XAMPP.
2. Start the Apache and MySQL services from the XAMPP Control Panel.

---

Step 3: Install Composer

1. Download and install Composer.
2. During installation, check the box to Add C:\xampp\php\php.exe to PATH.

---

Step 4: Install Node.js

1. Download and install Node.js.
2. Verify the installation by running the following commands in Command Prompt:

   node -v
   npm -v

---

Step 5: Clone or Download the Repository

Clone the repository to your local machine using Git:

git clone https://github.com/your-username/Everifi.git

Alternatively, download the repository as a ZIP file and extract it to your desired location.

---

Step 6: Navigate to the Project Folder

Open Command Prompt and navigate to the project folder:

cd path\to\Everifi

---

Step 7: Install Dependencies

1. Install Node.js dependencies:

   npm install

   • If you encounter permission issues, open Windows PowerShell (Administrator) and run:

     Set-ExecutionPolicy RemoteSigned

     Choose Y when prompted, then retry the npm install command.

2. Install Composer dependencies:

   composer install

---

Step 8: Set Up Environment Configuration

1. Create a .env file by copying the .env.example file:

   cp .env.example .env

2. Generate an application key for secure encryption and decryption:

   php artisan key:generate

3. Create a symbolic link for the storage folder:

   php artisan storage:link

---

Step 9: Create a Database

1. Open phpMyAdmin (or your preferred MySQL client).
2. Create a new database for the project (e.g., everifi).

---

Step 10: Configure the .env File

1. Open the .env file in a text editor.
2. Replace the following email configuration with the Mailtrap info you copied earlier:

   MAIL_MAILER=smtp
   MAIL_HOST=smtp.mailtrap.io
   MAIL_PORT=2525
   MAIL_USERNAME=your_mailtrap_username
   MAIL_PASSWORD=your_mailtrap_password
   MAIL_ENCRYPTION=tls

3. Update the database configuration settings:

   DB_DATABASE=everifi
   DB_USERNAME=root
   DB_PASSWORD=

   • Replace everifi with the name of the database you created.
   • If your database has a username and password, update DB_USERNAME and DB_PASSWORD accordingly.
4. Set the FILESYSTEM_DISK to public:

   FILESYSTEM_DISK=public

---

Step 11: Run Migrations and Compile Assets

1. Run the database migrations to set up the required tables:

   php artisan migrate

2. Compile the frontend assets:

   npm run dev

3. Build the production-ready assets:

   npm run build

---

Step 12: Start the Application

1. Start the development server:

   php artisan serve

   This will start the application at http://localhost:8000.

---

Step 13: Access the Application

Open your browser and navigate to http://localhost:8000. You should now see the Everifi application running locally.

---

Contributing

Contributions are welcome! If you'd like to contribute to Everifi, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes and push to your branch.
4. Submit a pull request with a detailed description of your changes.

---

License

This project is open-source and available under the MIT License.

---

Support

If you encounter any issues or have questions, feel free to open an issue on the GitHub repository.

---

Thank you for using Everifi! Happy coding! 🚀