https://github.com/devdario/purplebird
Send faster and easier emails with PurpleBird, A email sender browser tool
https://github.com/devdario/purplebird
browser-tools email-sender emailjs emails-service reactjs vite vitejs-react
Last synced: 11 months ago
JSON representation
Send faster and easier emails with PurpleBird, A email sender browser tool
- Host: GitHub
- URL: https://github.com/devdario/purplebird
- Owner: DevDario
- License: mit
- Created: 2023-09-01T12:38:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-05T20:39:43.000Z (over 1 year ago)
- Last Synced: 2025-03-25T16:51:07.882Z (12 months ago)
- Topics: browser-tools, email-sender, emailjs, emails-service, reactjs, vite, vitejs-react
- Language: JavaScript
- Homepage: https://purple-bird.vercel.app
- Size: 1.46 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# PurpleBird - Email Sending App Documentation
## Table of Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Prerequisites](#prerequisites)
4. [Installation](#installation)
5. [Usage](#usage)
6. [Contributing](#contributing)
7. [License](#license)
---
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.
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.
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/](https://nodejs.org/).
- **EmailJS Account**: Sign up for an EmailJS account at [https://www.emailjs.com/](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/](https://git-scm.com/).
Follow these steps to install and set up PurpleBird:
1. Clone the PurpleBird repository from GitHub:
```bash
git clone https://github.com/DevDario/purplebird.git
```
2. Navigate to the project directory:
```bash
cd purplebird
```
3. Install the project dependencies:
```bash
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.
### Starting the Application
1. Start the PurpleBird web application:
```bash
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.
We welcome contributions to PurpleBird! If you'd like to contribute to this project, please follow our [Contribution Guidelines](CONTRIBUTING.md).
PurpleBird is licensed under the MIT License. See the [LICENSE](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](https://github.com/DevDario/purplebird/issues) on our GitHub repository. Happy emailing!
Generated by ChatGPT.