Installation

Running Meeseeks with Docker 🐳 (Recommended)

1. Install Docker: If you haven't already, install Docker on your machine.

2. Environment Variables: Copy the .env.example file to a new file named docker-meeseeks.env and modify the necessary environment variables.

3. Run the Docker Container: Run the Docker container with the following command:

# Run the chat application 
docker run --env-file docker-meeseeks.env --add-host=host.docker.internal:host-gateway -p 8502:8502 ghcr.io/bearlike/meeseeks-chat:latest

# Run the REST API Server
docker run --env-file docker-meeseeks.env -p 5123:5123 --add-host=host.docker.internal:host-gateway ghcr.io/bearlike/meeseeks-api:latest

4. Default port for the Chat App is 8502 and REST API server is 5123. Now, you should be able to access the Meeseeks chat interface at http://hostname-or-ip:8502 in your web browser.
5. The Swagger docs for the API server is available at http://hostname_or_ip:5123/swagger-ui/ and the default API Key is msk-strong-password. Enjoy chatting with Meeseeks!

Docker Compose for Meeseeks 🐳

version: '3.8'

services:
  chat_app:
    image: ghcr.io/bearlike/meeseeks-chat:latest
    container_name: meeseeks-chat
    ports:
      - "18502:8502"
    env_file:
      - stack.env
    extra_hosts:
      - "host.docker.internal:host-gateway"

  rest_api_server:
    image: ghcr.io/bearlike/meeseeks-api:latest
    container_name: meeseeks-api
    ports:
      - "15123:5123"
    env_file:
      - stack.env
    extra_hosts:
      - "host.docker.internal:host-gateway"

Installing dependencies using Poetry 🛠️

This project is composed of multiple modules, each with its own set of dependencies. Follow the steps below to set up the project on your local machine.

Prerequisites

• Python 3.10 or higher
• Poetry - Simplifies managing Python packages and dependencies.

Note

Installation script for Mac and Linux Users: Clone the repository, navigate to the project root and run the below script:

chmod +x build-install.sh
./build-install.sh fallback-install

Manual Installation

1. Clone the repository:

   git clone https://github.com/bearlike/Personal-Assistant.git

2. Navigate to the root directory of the project and install the main module's dependencies:

   cd Personal-Assistant
   poetry install

3. To install the optional and development dependencies, navigate to the submodule directories (meeseeks-api and meeseeks-chat), and install their dependencies:

   poetry install --dev
   cd ../meeseeks-api
   poetry install
   cd ../meeseeks-chat
   poetry install
   cd ..

4. Environment Variables: Copy the .env.example file to a new file named .env and modify in the necessary environment variables.

Running the Meeseeks Chat Interface 🤖

After installing the dependencies, you can run the application with the following command:

cd ./meeseeks-chat
streamlit run chat_master.py