Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sugamkuber/auto-mailer
Mailing Automation Task with google oauth & openAPI
https://github.com/sugamkuber/auto-mailer
automation frontend gmail-api google-cloud openapi
Last synced: 5 days ago
JSON representation
Mailing Automation Task with google oauth & openAPI
- Host: GitHub
- URL: https://github.com/sugamkuber/auto-mailer
- Owner: SugamKuber
- Created: 2024-06-26T09:46:42.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-26T14:17:52.000Z (5 months ago)
- Last Synced: 2024-06-26T18:49:09.038Z (5 months ago)
- Topics: automation, frontend, gmail-api, google-cloud, openapi
- Language: TypeScript
- Homepage: https://auto-mailer.vercel.app
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Auto Mailer
## Backend setups
- Step 1 : Provide all the required creds in backend root/.env
```
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_CALLBACK=
FONTEND_REDIRECT=
MONGO_URI=
```
- Step 2 :
```
npm i
npm run dev (for development server)
npm run build (to build with tsc)
npm run start (to start with build dir)
```
## Frontend setup
- Step 1 : Provide BACKEND_URL = " " in /check.js file && /googlebutton.js file
- Step 2 :
```
npm i
npm run dev (for development server)
npm run build (to build with vite)
npm run preview (to run with vite build)
```
## Open API function
- OpenAPI function isnt impelmented due to its pricing
- However it can be implemented in line 77 Backend/src/jobs/emailProcess.ts
## Creds on Google
- Use [google console](https://console.cloud.google.com/) >> Api & Services ( Create a project is you dont have) >> Sidebar Oauth Consent Screen >> Credentials >> Create and copy the creds
- [IMP] Input your gmail for test account
- [IMP] Input you domains/urls for redirection
## Improvements
- Implementation expiry for tokens on redis caching
- Better monitoring for email job
- Implementation of bullMQ queues if needed for generation of openAPI mail replies
- Proper Frontend setup
- Other imp features
### Reminder
This app is only focused on backend
## Database setup
- Use mongo cloud or any mongo database url
- Remember to input the right username/password with network & access permissions
## Links
Backend Link: https://auto-mailer-server.up.railway.app/
Frontend Link: http://auto-mailer.vercel.app/
Github Link: https://github.com/SugamKuber/auto-mailer
## How tos
- Open frontend & Login with google button on home page
- If successfull will be redirected for [check page](https://auto-mailer.vercel.app/check) here enter your email and check
- To check if your auto mailing is active, input your email in the same page, it will show the status
- If expired, log in again from home page
- If failed, check all your config & permissions