https://github.com/xeven777/bday-reminder
Unique project which simply autosends Bday reminders!✨🎂 Emails sent by Resend, AI generated wishes too!😇 Uses github actions
https://github.com/xeven777/bday-reminder
actions ai aisdk birthday birthday-reminder birthday-wishes gemini github-actions resend vercel-ai-sdk
Last synced: 4 months ago
JSON representation
Unique project which simply autosends Bday reminders!✨🎂 Emails sent by Resend, AI generated wishes too!😇 Uses github actions
- Host: GitHub
- URL: https://github.com/xeven777/bday-reminder
- Owner: Xeven777
- Created: 2024-05-04T12:39:15.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-01T05:49:48.000Z (about 1 year ago)
- Last Synced: 2025-07-03T06:07:13.694Z (12 months ago)
- Topics: actions, ai, aisdk, birthday, birthday-reminder, birthday-wishes, gemini, github-actions, resend, vercel-ai-sdk
- Language: TypeScript
- Homepage: https://bday-reminder7.vercel.app
- Size: 5.25 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Birthday Reminder App 🎉
## 🗂️ Description
The Birthday Reminder App is a full-stack application designed to help users keep track of their friends' and family members' birthdays. The app allows users to add birthday reminders, generate AI-powered birthday wishes, and send automated email reminders. This project is perfect for developers looking for a comprehensive example of a real-world application built with Next.js, TypeScript, and Prisma.
The app is built with a focus on user experience, featuring a clean and intuitive interface, and is optimized for performance and scalability.
## ✨ Key Features
### Core Features
* **Birthday Reminder Management**: Add, edit, and delete birthday reminders with details such as name, birthday, email, and relationship.
* **AI-Powered Birthday Wishes**: Generate personalized birthday wishes using AI models.
* **Automated Email Reminders**: Send automated email reminders to users and their friends on birthdays.
### User Interface
* **Dashboard**: A user-friendly dashboard to view and manage birthday reminders, with features such as upcoming birthdays, this month's birthdays, and next month's birthdays.
* **Form Components**: Intuitive form components for adding and editing birthday reminders.
## 🗂️ Folder Structure
```mermaid
graph TD;
src-->app;
src-->components;
src-->lib;
src-->actions;
app-->dashboard;
app-->api;
components-->ui;
lib-->utils;
lib-->db;
actions-->ai-wish;
actions-->email;
```
## 🛠️ Tech Stack
## ⚙️ Setup Instructions
To run the project locally, follow these steps:
* Git clone the repository: `git clone https://github.com/Xeven777/bday-reminder.git`
* Install dependencies: `npm install`
* Start the development server: `npm run dev`
## 🤖 GitHub Actions
The project uses GitHub Actions to automate the process of sending birthday wishes. The workflow is defined in the `.github/workflows/actions.yml` file.
```mermaid
graph TD;
workflow-->daily-job;
daily-job-->send-wishes;
```
## 📝 Configuration Files
The project uses several configuration files, including:
* `.eslintrc.json`: ESLint configuration file that extends the Next.js core web vitals configuration.
* `.vscode/settings.json`: Visual Studio Code settings file with a single setting for Next.js.
* `postcss.config.mjs`: PostCSS configuration file that uses the Tailwind CSS plugin.
* `next.config.mjs`: Next.js configuration file that enables PWA support with custom settings.
* `prisma/schema.prisma`: Prisma schema file that defines the database model for the application.
* `tsconfig.json`: TypeScript configuration file that sets up the compiler options for the project.
Anish
Passionate developer with a love for problem-solving, efficient and creative thinking.
