ste-hue / BestWishes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Best Wishes App

The Best Wishes App is a cross-platform mobile application that allows you to send personalized responses for Christmas and birthday wishes, as well as thank-you messages. The app uses the ChatGPT API to generate personalized responses and the phone's contact list to send the messages.

Features

  • First Iteration: Send personalized messages for Christmas and birthday wishes.
  • Final Version:
    • Automatically send personalized messages for Christmas and birthday wishes.
    • Automatically send thank-you messages when someone wishes you.
    • Personalized responses using ChatGPT API.
    • Integration with the phone's contact list.
    • Scheduling of messages using Google Calendar API

Requirements

  • First Iteration:
    • iOS or Android device
    • Internet connection
    • OpenAI API Key
  • Final Version:
    • iOS or Android device
    • Internet connection
    • Google Calendar API Key
    • OpenAI API Key

Getting Started

First Iteration:

  1. Clone the repository and navigate to the project directory
  2. Install the dependencies by running npm install or yarn install
  3. Create a .env file and add your OpenAI API key
  4. Run the app on an emulator or on a device by running npm run android or npm run ios

Final Version:

  1. Clone the repository and navigate to the project directory
  2. Install the dependencies by running npm install or yarn install
  3. Create a .env file and add your Google Calendar API key and OpenAI API key
  4. Run the app on an emulator or on a device by running npm run android or npm run ios
  5. Create events for birthdays and Christmas in your Google Calendar

Contributing

We welcome contributions to the Best Wishes App. If you're interested in contributing, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

It's important to note that the final version includes the scheduling mechanism, which allows the app to automatically send the messages on the specific date and time of the event. This functionality is not available in the first iteration, where the user has to manually select the recipient and send the message.


Best Wishes App System Design

The Best Wishes App is a platform that allows users to send and receive personalized wishes and messages. The system design is broken down into several components, each with its own set of responsibilities.

User Management The user management component is responsible for allowing users to sign up and log in to the platform. This component will use a combination of email and password authentication, as well as the ability to log in with social media accounts.

Wishes Management The wishes management component is responsible for allowing users to create, view, and manage their wishes. This includes creating new wishes, editing existing wishes, and deleting wishes that are no longer needed. Users will also be able to categorize their wishes based on the occasion, recipient, and more.

Wish Delivery The wish delivery component is responsible for delivering wishes to the intended recipient. This can be done via email, SMS, or through in-app notifications. Users will also be able to schedule wishes to be delivered at a specific date and time, or opt to send them immediately.

Payment System The payment system component is responsible for handling all transactions within the platform. This includes accepting payments for premium features and handling the distribution of funds to the appropriate parties. The payment system will be integrated with a secure and reliable payment gateway, such as Stripe or PayPal.

Database The database component is responsible for storing all the data related to the platform. This includes user information, wishes, payments, and more. The database will be implemented using a NoSQL database, such as MongoDB, to handle the high volume of data.

API The API component is responsible for providing a way for different parts of the system to interact with each other. This includes creating and retrieving data from the database, as well as delivering wishes to the intended recipient. The API will be built using a RESTful architecture and will be secured using authentication and authorization protocols.

Front-end The front-end component is responsible for providing a user-friendly interface for users to interact with the platform. This includes allowing users to sign up and log in, create and manage their wishes, and view their wish history. The front-end will be built using modern web technologies, such as React or Angular.

Deployment The platform will be deployed on a cloud-based infrastructure, such as Amazon Web Services (AWS) or Google Cloud Platform (GCP), for scalability and reliability. The platform will be constantly monitored for performance and security issues, and regular updates will be deployed to ensure optimal performance.

With its user-friendly interface, powerful features, and reliable delivery system, the Best Wishes App is the ideal platform for sending and receiving personalized wishes and messages.

About


Languages

Language:JavaScript 100.0%