Skip to content

Latest commit

 

History

History
105 lines (83 loc) · 3.19 KB

README.md

File metadata and controls

105 lines (83 loc) · 3.19 KB
Raw

EA - Your Personal AI Friend and Healer

EA Logo

Overview

EA is a private personal AI designed to provide companionship and assistance to individuals dealing with health issues, depression, and memory challenges. EA offers familiar conversation and reliable support, aiming to improve overall well-being and quality of life.

Features

  • Health Monitoring: Track your physical health metrics and receive personalized advice.
  • Mental Health Support: Engage in comforting conversations and receive strategies to manage depression and anxiety.
  • Memory Assistance: Get reminders and help with organizing daily tasks to manage memory issues.
  • Companionship: Enjoy meaningful and familiar conversations to combat loneliness.

Getting Started

To get started with EA, follow these steps:

Prerequisites

  • PHP 8.0+
  • Composer
  • Web server (Apache, Nginx, etc.)

Installation

  1. Clone the Repository:

    git clone https://github.com/yourusername/ea-ai-friend.git
cd ea-ai-friend

  2. Install Dependencies:

    composer install

  3. Set Up Environment Variables: Create a .env file in the root directory and add the following:

    OPENAI_API_KEY=your_openai_api_key

  4. Configure Web Server: Ensure your web server is set up to serve the application. For Apache, you might add a virtual host configuration like:

    <VirtualHost *:80>
    ServerName ea.local
    DocumentRoot /path/to/ea-ai-friend/public
    <Directory /path/to/ea-ai-friend/public>
        AllowOverride All
        Require all granted
    </Directory>
</VirtualHost>

  5. Run the Application: Ensure your web server is running and navigate to your application's URL in your browser.

Usage

Once the application is running, EA will be available to interact with you through the web interface. Simply type your queries or responses, and EA will engage in a conversation to provide the assistance you need.

Example Commands

  • Health Check: 
    EA, how is my health today?
  • Mental Health Support: 
    EA, I'm feeling down. Can you help?
  • Memory Assistance: 
    EA, remind me to take my medication at 8 PM.

Contributing

We welcome contributions to improve EA. To contribute, please follow these steps:

  1. Fork the Repository: Click on the "Fork" button at the top right of this repository page.

  2. Create a Feature Branch:

    git checkout -b feature/your-feature-name

  3. Commit Your Changes:

    git commit -m 'Add some feature'

  4. Push to the Branch:

    git push origin feature/your-feature-name

  5. Open a Pull Request: Submit your pull request, describing the changes you made.

License

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

Contact

For questions, suggestions, or feedback, please reach out to us at [email protected].

Thank you for choosing EA as your personal AI friend and healer. We hope EA brings you comfort, support, and improved well-being.