https://github.com/richardevcom/memba
SMS reminders for elderly using Twilio API, Vertex AI & Google Cloud services.
https://github.com/richardevcom/memba
api challange cloud gemini google mysql prisma run sms sql ts twilio typescript vertex
Last synced: 12 months ago
JSON representation
SMS reminders for elderly using Twilio API, Vertex AI & Google Cloud services.
- Host: GitHub
- URL: https://github.com/richardevcom/memba
- Owner: richardevcom
- License: other
- Created: 2024-06-24T18:25:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T02:01:23.000Z (over 1 year ago)
- Last Synced: 2024-07-26T03:25:41.448Z (over 1 year ago)
- Topics: api, challange, cloud, gemini, google, mysql, prisma, run, sms, sql, ts, twilio, typescript, vertex
- Language: TypeScript
- Homepage: https://dev.to/richardevcom/memba-twilio-vertex-ai-reminder-system-for-seniors-who-dont-memba-5h02
- Size: 265 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## 'memba? SMS Reminders for Seniors
**Memba** is a digital assistant designed to help seniors stay on top of their daily tasks by sending them SMS reminders. It leverages the power of Google Cloud services and machine learning to provide a user-friendly and intelligent solution.
_*This project was created as part of **Twilio challange**._
👉 **[Read article and see demo here.](https://dev.to/richardevcom/memba-twilio-vertex-ai-reminder-system-for-seniors-who-dont-memba-5h02)**
### Features
- **Simple and Familiar:** Memba utilizes SMS, a technology most seniors are already comfortable with. No need to learn new apps or interfaces!
- **AI-Powered Understanding:** Vertex AI, a powerful language model from Google Cloud, ensures accurate parsing of reminder messages, even with variations in phrasing.
- **Secure Storage:** Reminders are securely stored in a Google Cloud SQL MySQL database.
- **Automated Delivery:** Scheduled background jobs ensure timely delivery of reminder notifications via SMS.
### Installation
**Prerequisites:**
- Node.js and npm, pnpm (or yarn) installed on your system.
- A Twilio account with a phone number.
- A Google Cloud project with Cloud Run, Vertex AI and Cloud SQL enabled.
**Setting Up:**
1. Clone this repository:
```bash
git clone https://github.com/richardevcom/memba.git
```
2. Install dependencies:
```bash
npm install
```
**Configuration:**
1. Create a `.env` file in the project root directory.
2. Add the following environment variables to your `.env` file, replacing the placeholders with your actual credentials:
```
TWILIO_ACCOUNT_SID=your_twilio_account_sid
TWILIO_AUTH_TOKEN=your_twilio_auth_token
TWILIO_PHONE_NUMBER=your_twilio_phone_number
API_ENDPOINT=your_node_api_endpoint
VERTEX_AI_PROJECT_ID=your_vertex_ai_project_id
VERTEX_AI_LOCATION=your_vertex_ai_location
GOOGLE_CLOUD_PROJECT=your_google_cloud_project_id
CLOUD_SQL_CONNECTION_STRING=your_cloud_sql_connection_string
```
**Running Memba:**
```bash
npm start
```
This will start the Memba application in production mode.
### Development
For development purposes, you can use the following commands:
- `npm run build`: Builds the application for development.
- `npm run dev`: Starts the application in development mode with hot reloading.
- `npm run db:push`: Pushes your Prisma schema changes to the database.
- `npm run db:migrate`: Applies Prisma migrations to your database.
- `npm run db:studio`: Opens Prisma Studio for interacting with your database.
### License
Memba is licensed under the GPL-3.0-only license. See the [`LICENSE`](LICENSE) file for details.
### Contributing
We welcome contributions to Memba! Please see the `CONTRIBUTING.md` file (if it exists) for guidelines on how to contribute.
### Authors
- [Ayush](https://github.com/is-it-ayush)
- [richardevcom](https://github.com/richardevcom)