Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joewadk authored Sep 6, 2024
1 parent ee8f115 commit fa4d510
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
## BYTE Emailer
Hello. This is the BYTE mass email project designed by Jawad Kabir. The main goal of this app is to push an email to a large amount of club members without the need of using external software like mailchimp. While those software are free and easy to use, as computer science majors we have the tools and the capability of creating software for any of our needs, so why not make our own application that pushes our messages. This isn't intended to be the most robust application ever, but it is meant to be easy to use. We want to be able to reach all of our members without having a "2 emails per month" or any other limitation that another mail service has.
Hello. This is the BYTE mass email project designed by Jawad Kabir and Fahad Faruqi. The main goal of this app is to push an email to a large amount of club members without the need of using external software like mailchimp. While those software are free and easy to use, as computer science majors we have the tools and the capability of creating software for any of our needs, so why not make our own application that pushes our messages. This isn't intended to be the most robust application ever, but it is meant to be easy to use. We want to be able to reach all of our members without having a "2 emails per month" or any other limitation that another mail service has.
## Getting Started
Make sure you install the dependencies using the following command
```pip install -r requirements.txt```

To install all of the dependencies, you'll need to first make a virtual environment like so :
```bash
py -m venv .venv
```
Next, you'll want to activate the venv like so:
```bash
.venv/Scripts/activate
```
Next, pip install your dependencies
```bash
pip install -r req.txt
```
And now you should be good to go!
## Functionalities
So with this project I used a Firebase database to hold the emails of well over 200+ members. This will be scraped from our xlsx file that we place as an input. We would then pipe the emails into the email client through querying, and then using smtp connection to the google server, we will push all the emails to the recipients' accounts. Other than that, I intend to create a FastAPI backend just for the sake of having one. Not entirely sure if I will implement a front end, prob will.

Expand Down

0 comments on commit fa4d510

Please sign in to comment.