GithubHelp home page GithubHelp logo

richardevcom / memba Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 1.0 270 KB

SMS reminders for elderly using Twilio API, Vertex AI & Google Cloud services.

Home Page: https://dev.to/richardevcom/memba-twilio-vertex-ai-reminder-system-for-seniors-who-dont-memba-5h02

License: Other

JavaScript 20.04% Dockerfile 5.03% TypeScript 74.93%
api challange cloud gemini google mysql prisma run sms sql ts twilio typescript vertex

memba's Introduction

'memba? SMS Reminders for Seniors

GitHub package.json version

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.

Github-sponsors

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:
git clone https://github.com/richardevcom/memba.git
  1. Install dependencies:
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:

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 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

memba's People

Contributors

is-it-ayush avatar richardevcom avatar

Stargazers

Hans Piña avatar  avatar  avatar

Watchers

Lucian avatar  avatar

Forkers

luvnft

memba's Issues

fix: hero section ux

Logo animation is running continuously. If we animate it only once, it'll provide better UX because currently user is distracted to that animation instead of the phone number that we are highlighting.

Screen.Recording.2024-06-25.at.10.58.04.AM.mov

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.