{"id":24953341,"url":"https://github.com/codexparas/finmate","last_synced_at":"2025-03-28T19:45:56.421Z","repository":{"id":259153974,"uuid":"868151234","full_name":"CodexParas/FinMate","owner":"CodexParas","description":"FinMate is a Spring Boot application designed to facilitate efficient email query tracking and management, utilizing the Gmail API and AI-powered automated responses. This application allows users to manage customer queries, send AI-generated replies, and track email interactions seamlessly.","archived":false,"fork":false,"pushed_at":"2024-10-23T01:14:22.000Z","size":52,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-03T03:34:07.987Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodexParas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-05T15:55:56.000Z","updated_at":"2024-10-23T01:14:25.000Z","dependencies_parsed_at":"2024-10-23T04:07:35.101Z","dependency_job_id":"0b6126d6-f30f-4050-b5a4-b3f70d2e55b9","html_url":"https://github.com/CodexParas/FinMate","commit_stats":null,"previous_names":["codexparas/finmate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodexParas%2FFinMate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodexParas%2FFinMate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodexParas%2FFinMate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodexParas%2FFinMate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodexParas","download_url":"https://codeload.github.com/CodexParas/FinMate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246093097,"owners_count":20722395,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-03T03:34:38.513Z","updated_at":"2025-03-28T19:45:56.386Z","avatar_url":"https://github.com/CodexParas.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FinMate - Your AI Banking Queries Assistant\n\n**FinMate** is a Spring Boot application designed to facilitate efficient email query tracking and management, utilizing\nthe Gmail API and AI-powered automated responses. This application allows users to manage customer queries, send\nAI-generated replies, and track email interactions seamlessly.\n\n## Table of Contents\n\n- [Features](#features)\n- [Technologies Used](#technologies-used)\n- [Installation](#installation)\n- [Usage](#usage)\n- [AI Integration](#ai-integration)\n- [API Endpoints](#api-endpoints)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- Track email queries from customers.\n- Use AI to generate automated replies, ensuring consistent and efficient responses.\n- Manage ticketing for customer queries.\n- Use OAuth 2.0 for secure Gmail API access.\n- Log interactions for better customer service.\n\n## Technologies Used\n\n- Java 17\n- Spring Boot\n- Spring Security\n- Spring Data JPA\n- PostgreSQL\n- Gmail API\n- OpenAI API for generating replies\n- Jsoup for HTML parsing\n- Lombok for boilerplate code reduction\n\n## Installation\n\n### Prerequisites\n\n- Java 17 or higher\n- Maven\n- PostgreSQL Database\n- OpenAI API Key\n\n### Steps\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/CodexParas/FinMate.git\n   cd FinMate\n   ```\n\n2. **Update application properties:**\n\n   Modify the `src/main/resources/application.properties` file with your PostgreSQL database credentials and OpenAI API\n   key:\n\n   ```properties\n   spring.datasource.url=jdbc:postgresql://localhost:5432/yourdbname\n   spring.datasource.username=yourusername\n   spring.datasource.password=yourpassword\n   spring.ai.openai.api-key=your-openai-api-key\n   ```\n\n3. **Add Google services JSON file:**\n\n    - Download the `credentials.json` file from the Google Cloud Console for your OAuth 2.0 client ID.\n    - Place the `credentials.json` file in the `src/main/resources` directory.\n\n\n4. **Install dependencies:**\n\n   Run the following command to install the necessary dependencies:\n\n   ```bash\n   mvn clean install\n   ```\n\n5. **Run the application:**\n\n   Start the application using:\n\n   ```bash\n   mvn spring-boot:run\n   ```\n\n6. **Access the API documentation:**\n\n   Once the application is running, you can access the API documentation at\n   `http://localhost:8080/api/v1/swagger-ui/index.html`.\n\n### Dockerization (Optional)\n\nTo run the application in a Docker container:\n\n1. **Build the Docker image:**\n\n   ```bash\n   docker build -t finmate-api .\n   ```\n\n2. **Run the Docker container:**\n\n   ```bash\n   docker run -p 8080:8080 finmate-api\n   ```\n\n## Usage\n\n- The application exposes RESTful endpoints for interacting with email queries, ticket management, and sending replies.\n- Ensure you have a valid OAuth 2.0 client ID and secret for accessing the Gmail API.\n\n## AI Integration\n\nThe AI component of FinMate leverages OpenAI's API to generate contextually relevant responses to customer queries. This\nhelps streamline customer support and provide prompt, accurate, and personalized responses.\n\n- **Automated Replies**: When a customer query is received, FinMate analyzes the content and generates an appropriate\n  response using AI. The generated response can either be sent automatically or reviewed by a human agent before\n  sending.\n- **Natural Language Processing**: Using OpenAI, the system can understand the intent and tone of customer emails,\n  allowing for more empathetic and helpful replies.\n\nTo set up AI integration, ensure that the `spring.ai.openai.api-key` property in `application.properties` is set with\nyour OpenAI API key.\n\n## API Endpoints\n\n### Email Queries\n\n- `POST /api/email-query` - Insert a new email query.\n- `GET /api/email-query/{id}` - Get details of an email query by ID.\n\n### Tickets\n\n- `POST /api/tickets` - Create a new ticket.\n- `GET /api/tickets/{id}` - Get details of a ticket by ID.\n\n### Authentication\n\n- `POST /api/auth/login` - Authenticate user and return JWT token.\n\n### AI Responses\n\n- `POST /api/email-query/{id}/generate-response` - Generate an AI response for an email query.\n\n## Contributors\n\n- [Paras Gupta](https://github.com/CodexParas)\n\n## Acknowledgments\n\nSpecial thanks to the developers and maintainers of the technologies used in this project.\n\n## Contributing\n\nContributions are welcome! Please submit a pull request or open an issue for discussion.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n---\n\n### Instructions to Customize:\n\n- Replace `yourusername`, `yourdbname`, `yourpassword`, `your-openai-api-key` and other placeholder values with actual\n  information relevant to your project.\n- Feel free to add more features, customize AI functionalities, or adjust the endpoints as per your specific\n  requirements.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodexparas%2Ffinmate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodexparas%2Ffinmate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodexparas%2Ffinmate/lists"}