https://github.com/thrishank/gmail-ai
https://github.com/thrishank/gmail-ai
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/thrishank/gmail-ai
- Owner: thrishank
- Created: 2024-06-06T09:09:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T18:48:57.000Z (over 1 year ago)
- Last Synced: 2025-11-12T20:01:49.067Z (7 months ago)
- Language: TypeScript
- Homepage: https://gmail-ai.vercel.app
- Size: 21.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Description
This project is a Gmail AI application that uses Google's Gmail API and Gemini AI API to classify emails into different categories. It integrates with Gmail to help users manage and organize their emails efficiently.
### Demo
### Tech Stack & Key Features
- **Frontend**: Built using Next.js and tailwind CSS for styling.
- **Backend**: Next.js API routes
- **Authentication**: Implements Google Oauth user authentication using next-auth.
- **Integration**: Get's the last X number of emails of the user using the Gmail API and Uses Google's Gemini API for email classification.
- **Email Classification**: Classifies emails into predefined categories such as Important, Promotions, Social, Marketing, Spam, and General.
- **User Interface**: Provides an intuitive interface for users to view and classify their emails.
### Setup
1. Clone the repository.
```sh
git clone https://github.com/thrishank/gmail-ai.git
```
2. Navigate to the project directory.
```sh
cd gmail-ai
```
3. Install dependencies using npm.
```sh
npm install
```
4. Copy the content from .env.example and create a new file named .env with the copied content.
```sh
cp .env.example .env
```
- `GOOGLE_CLIENT_ID`: Google client ID for authentication.
- `GOOGLE_CLIENT_SECRET`: Google client secret for authentication.
- `NEXTAUTH_SECRET`: Secret key for NextAuth.
5. Start the development server.
```sh
npm run dev
```
## Using Docker
```sh
docker-compose up
```
### File Structure
- `app/`: Contains the main application files.
- `components/`: Includes reusable React components.
- `lib/`: Contains authentication-related files.
- `public/`: Stores public assets like images.
- `app/api/`: Includes API routes for Gmail and AI classification.
### Scripts
- `npm run dev`: Starts the development server.
- `npm run build`: Builds the project for production.
- `npm run start`: Starts the production server.
### Additional Notes
- Ensure to set up the required environment variables before running the application.