https://github.com/kliiyu/friday

FRIDAY - an open-source AI assistant, Friday is my tool for learning about different technologies, there is always something more I can add or do better.
https://github.com/kliiyu/friday

ai docker docker-compose free gpt learning learning-by-building local mistral ollama open-source

Last synced: 12 days ago
JSON representation

FRIDAY - an open-source AI assistant, Friday is my tool for learning about different technologies, there is always something more I can add or do better.

• Host: GitHub
• URL: https://github.com/kliiyu/friday
• Owner: Kliiyu
• License: mit
• Created: 2024-10-29T08:47:25.000Z (16 days ago)
• Default Branch: main
• Last Pushed: 2024-11-01T20:16:30.000Z (13 days ago)
• Last Synced: 2024-11-01T21:16:52.556Z (13 days ago)
• Topics: ai, docker, docker-compose, free, gpt, learning, learning-by-building, local, mistral, ollama, open-source
• Language: Python
• Homepage:
• Size: 237 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# FRIDAY

# Getting started

Welcome to the FRIDAY project! For more details and a step by step install guide, visit our [documentation](https://kliiyu.github.io/FRIDAY/).

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

> **Important Note:** The following installation steps are outdated and may not work with the latest version of FRIDAY. Please refer to the [official documentation](https://kliiyu.github.io/FRIDAY/) for the most up-to-date instructions.

1. Ensure you have [Ollama](https://ollama.com) and [Python](https://www.python.org) installed on your system.

2. Clone the repository:

   ```sh

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

   ```

3. Navigate to the project directory:

   ```sh

   cd FRIDAY

   ```

4. Set up a Python virtual environment:

   ```sh

   python -m venv .venv

   ```

5. Activate the virtual environment:

   - On Windows:

     ```sh

     .\venv\Scripts\activate

     ```

   - On macOS/Linux:

     ```sh

     source venv/bin/activate

     ```

6. Install the required dependencies:

   ```sh

   pip install -r ./requirements.txt

   ```

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

8. Run FRIDAY

   ```sh

   python main.py

   ```

> Check out the official [documentation](https://kliiyu.github.io/FRIDAY/) for useful information and a more detailed installation guide.

## License

Please see [LICENSE](LICENSE) for details on how the code in this 

repo is licensed.