FRIDAY

Getting started

Welcome to the FRIDAY project! For more details and a step by step install guide, visit our documentation.

Introduction to FRIDAY

FRIDAY is an ambitious project: a personal AI assistant inspired by the intelligent systems in the Iron Man series. Designed to run functions, engage in casual conversation, and remember key information, FRIDAY is built to bring a highly interactive AI experience to life.

FRIDAY isn't just another assistant; it's my own experiment with technology, combining tools and APIs in innovative ways to push the boundaries of what a personal AI can achieve. This side project lets me explore, test, and integrate technologies that bring FRIDAY closer to the capabilities of Iron Man's JARVIS and FRIDAY assistants.

Quick Start

Installation Steps

1. Ensure you have Ollama and Python installed on your system.
2. Clone the repository:

   git clone https://github.com/kliiyu/FRIDAY.git

3. Navigate to the project directory:

   cd FRIDAY

4. Set up a Python virtual environment:

   python -m venv .venv

5. Activate the virtual environment:
   • On Windows:

     .\venv\Scripts\activate

   • On macOS/Linux:

     source venv/bin/activate

6. Install the required dependencies:

   pip install -r ./config/requirements.txt

7. Make and fill in a .env file in ./config (use .env.example as reference)
8. Run FRIDAY

   python main.py

Check out the official documentation for useful information and a more detailed installation guide.

---