/PurpleBird

Send faster and easier emails with PurpleBird, A email sender browser tool

Primary LanguageJavaScriptMIT LicenseMIT

PurpleBird - Email Sending App Documentation

Table of Contents

  1. Introduction
  2. Features
  3. Prerequisites
  4. Installation
  5. Usage
  6. Contributing
  7. License

1. Introduction

Welcome to PurpleBird, the easy-to-use email sending app that allows you to send emails quickly and effortlessly using your Gmail account. With PurpleBird, you can send messages by simply providing your email address, the recipient's email address, and your message. It's as simple as that! This documentation will guide you through the installation, setup, and usage of the PurpleBird app.

2. Features

PurpleBird offers the following key features:

  • Easy Email Sending: Send emails to anyone with just a few simple inputs.

  • Gmail Integration: Utilize your Gmail account to send emails securely.

  • Customizable Messages: Compose personalized messages for your recipients.

3. Prerequisites

Before you can use PurpleBird, make sure you have the following prerequisites in place:

  • Node.js: Ensure you have Node.js installed on your system. You can download it from https://nodejs.org/.

  • EmailJS Account: Sign up for an EmailJS account at https://www.emailjs.com/ to obtain your API key.

  • Gmail Account: You need a Gmail account to send emails using PurpleBird.

  • Git: If you plan to clone the PurpleBird repository, you should have Git installed. You can download it from https://git-scm.com/.

4. Installation

Follow these steps to install and set up PurpleBird:

  1. Clone the PurpleBird repository from GitHub:

    git clone https://github.com/DevDario/purplebird.git

  2. Navigate to the project directory:

    cd purplebird

  3. Install the project dependencies:

    npm install

  4. Create a .env file in the project root and add your EmailJS API key:

    EMAILJS_API_KEY=your_emailjs_api_key_here

  5. Save the .env file.

5. Usage

Starting the Application

  1. Start the PurpleBird web application:

    npm run dev

  2. Open your web browser and navigate to http://localhost:5173 or other showed in your terminal to access PurpleBird.

Sending Emails

  1. Enter your Gmail address in the "Your Email" field.

  2. Enter the recipient's email address in the "your friend's Email" field.

  3. Compose your message in the "Message" field.

  4. Click the "Send Email" button.

  5. PurpleBird will use your Gmail account via EmailJS to send the email.

Stopping the Application

To stop the PurpleBird web application, press Ctrl + C in the terminal where it's running.

6. Contributing

We welcome contributions to PurpleBird! If you'd like to contribute to this project, please follow our Contribution Guidelines.

7. License

PurpleBird is licensed under the MIT License. See the LICENSE file for details.

Thank you for using PurpleBird! If you encounter any issues or have suggestions for improvements, please feel free to create an issue on our GitHub repository. Happy emailing!

Generated by ChatGPT.