Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yacosta738/summary-bender
Summary Application
https://github.com/yacosta738/summary-bender
nuxtjs
Last synced: about 1 month ago
JSON representation
Summary Application
- Host: GitHub
- URL: https://github.com/yacosta738/summary-bender
- Owner: yacosta738
- Created: 2024-07-12T15:16:41.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-06T23:08:38.000Z (3 months ago)
- Last Synced: 2024-09-18T17:42:56.533Z (about 2 months ago)
- Topics: nuxtjs
- Language: Vue
- Homepage: https://summary-bender.vercel.app/
- Size: 1.96 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Summary Bender
Welcome to the Summary Bender application, an advanced tool that uses artificial intelligence to efficiently and accurately summarize emails.
## Documentation
Check out the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more about working with the framework.
## Setup
Make sure to install the necessary dependencies:
```bash
# npm
npm install
# pnpm
pnpm install
# yarn
yarn install
# bun
bun install
```
## Development Server
Start the development server on `http://localhost:3000`:
```bash
# npm
npm run dev
# pnpm
pnpm run dev
# yarn
yarn dev
# bun
bun run dev
```
## Production
Build the application for production:
```bash
# npm
npm run build
# pnpm
pnpm run build
# yarn
yarn build
# bun
bun run build
```
Locally preview the production build:
```bash
# npm
npm run preview
# pnpm
pnpm run preview
# yarn
yarn preview
# bun
bun run preview
```
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
## Environment Variables
Ensure you set up the following environment variables in your `.env` file for the application to function properly:
```env
SUPABASE_URL="https://example.supabase.co"
SUPABASE_KEY=""
SMTP_HOST="smtp.gmail.com"
SMTP_PORT=587
IMAP_HOST="imap.gmail.com"
IMAP_PORT=993
SMTP_USER=""
SMTP_PASS=""
OPENAI_API_KEY=""
```
### Using Gmail
To use Gmail as your email provider, you need to set up an app password and enable IMAP. Follow these steps:
1. Enable IMAP in Gmail: Follow the instructions in this [Google support article](https://support.google.com/mail/answer/7126229) to enable IMAP for your Gmail account.
2. Create an App Password: If you have 2-Step Verification enabled, you need to create an app password to use with your email application. Follow the instructions in this [Google support article](https://support.google.com/accounts/answer/185833) to create an app password.
Replace with your Gmail address and with the app password you created.
## Features
- **Email Summaries**: Uses artificial intelligence to summarize email content.
- **Supabase Integration**: Utilizes Supabase for database management.
- **SMTP/IMAP Support**: Supports email protocols for sending and receiving emails.
- **OpenAI API**: Integrates the OpenAI API to generate high-quality summaries.
## Contribution
If you want to contribute to this project, please open an issue or a pull request on the [GitHub repository](https://github.com/yacosta738/summary-bender).
## License
This project is licensed under the MIT License. See the `LICENSE` file for more details.
Thank you for using Summary Bender!