https://github.com/athul/mailmon
Mass Email with Go+SMTP with a frontend in Vue. Emails can be written in Markdown
https://github.com/athul/mailmon
email gin-gonic go sendgrid smtp vuejs
Last synced: about 1 year ago
JSON representation
Mass Email with Go+SMTP with a frontend in Vue. Emails can be written in Markdown
- Host: GitHub
- URL: https://github.com/athul/mailmon
- Owner: athul
- License: gpl-3.0
- Created: 2020-08-07T05:17:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-03T17:15:13.000Z (over 5 years ago)
- Last Synced: 2024-04-20T09:21:13.076Z (about 2 years ago)
- Topics: email, gin-gonic, go, sendgrid, smtp, vuejs
- Language: Go
- Homepage:
- Size: 275 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mailmon
MailMon is a Mass Emailer with a Vue Frontend and a Go Backend(Gin) and uses Gmail's SMTP to send emails to groups of People.
Mailmon is made and currently used for a sending emails to all students in My class and for educational purposes.
## Using it
Since sending emails to many people take quite some time and server's power to compute. It's better that you use it locally.
- Clone the Project
### Frontend
- `$ cd frontend`
- Use Yarn or Npm to install the dependencies
```bash
$ yarn install
# OR
$ npm install
```
- Build the Files
```bash
$ yarn build
#OR
$ npm run build
```
This command will generate static(HTML,CSS and JS) files which will be used by the server to show the webpage like below
### Server
- Install Go and do the setup
- run `go mod download` to download the dependencies
- Run the server
```bash
$ go run main.go # to run the server
# OR
$ go build main.go # generates static binary
$ ./main # Execute the binary
```
A server will start at port [8080](http://localhost:8080). The `/` endpoint will show our frontend.
### SMTP
- Create a `.env` file with details like this
```text
USERNAME=
PASSWORD=
```
### Contributing
Possibly I'll rewrite the backend to Go to try the speed. Yeah and I'm accepting PRs and Issues. Feel free to open One😄
## TODO
- [] Email Templates to improve visibility