88 lines
1.8 KiB
Markdown
88 lines
1.8 KiB
Markdown
# iMail - Temporary Email Service
|
|
|
|
iMail is a simple, Laravel 12-based web application that provides a temporary email service. It allows users to create disposable email addresses to receive emails without revealing their personal email addresses.
|
|
|
|
## Features
|
|
|
|
- Create temporary email addresses.
|
|
- Receive and read emails sent to temporary addresses.
|
|
- Easy-to-use interface for checking received emails.
|
|
- Email addresses expire after a specified time or once accessed.
|
|
|
|
## Requirements
|
|
|
|
Before you start, ensure you have the following installed:
|
|
|
|
- **PHP 8.1** or higher
|
|
- Composer
|
|
- Laravel 12.x
|
|
- MySQL or SQLite for the database
|
|
|
|
## Installation
|
|
|
|
### Step 1: Clone the Repository
|
|
|
|
```bash
|
|
git clone https://github.com/your-username/imail.git
|
|
cd imail
|
|
```
|
|
|
|
### Step 2: Install Dependencies
|
|
|
|
Run the following command to install the required PHP dependencies:
|
|
|
|
```bash
|
|
composer install
|
|
```
|
|
### Step 3: Environment Configuration
|
|
|
|
Copy the `.env.example` file to create your `.env` file:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
Edit the `.env` file and configure the database and other environment settings:
|
|
|
|
```env
|
|
DB_CONNECTION=mysql
|
|
DB_HOST=127.0.0.1
|
|
DB_PORT=3306
|
|
DB_DATABASE=imail
|
|
DB_USERNAME=root
|
|
DB_PASSWORD=
|
|
```
|
|
|
|
### Step 4: Generate Application Key
|
|
|
|
Generate the Laravel application key by running:
|
|
|
|
```bash
|
|
php artisan key:generate
|
|
```
|
|
|
|
### Step 5: Migrate the Database
|
|
|
|
Run the database migrations to set up the required tables:
|
|
|
|
```bash
|
|
php artisan migrate
|
|
```
|
|
|
|
### Step 6: Serve the Application
|
|
|
|
Start the Laravel development server:
|
|
|
|
```bash
|
|
php artisan serve
|
|
```
|
|
|
|
Your application will be available at `http://127.0.0.1:8000`.
|
|
|
|
## Usage
|
|
|
|
1. Go to the homepage of your application.
|
|
2. Create a temporary email address.
|
|
3. Use the email address to receive emails.
|
|
4. View received emails in the inbox section.
|