J.A.R.V.I.S

📋 Table of contents

- [J.A.R.V.I.S](#jarvis) - [About](#about) - [Prerequisites](#prerequisites) - [Usage](#usage) - [Testing](#testing) - [Documentation](#documentation) - [Team](#team) - [License](#license)

About

Just A Rather Very Intelligent System (J.A.R.V.I.S). We’re building an AI assistant inspired by Iron Man's Jarvis, capable of managing and solving complex tasks autonomously. Users should be able to converse with Jarvis naturally. Similar to Jarvis in the movies, or the ChatGPT4o demo.

J.A.R.V.I.S is a voice-controlled AI assistant that can help you with various tasks. It is designed to be a personal assistant that can help you with everyday tasks, such as setting reminders, answering questions, and providing information. The goal of J.A.R.V.I.S is to make your life easier by providing you with the information you need when you need it.

Main functionality will be:

Natural conversation (TTS, Speech, Norsk?)
Simple function execution
Long term memory using RAG & Vector DBs
Reliability (Validate input & output)
Sub-processes (Do stuff while talking to the user, like browsing the web)

Reminder - Not suited for production

Traffic on this application is NOT encrypted. Only host it yourself and do NOT deploy to a public server where others can access the site.

Prerequisites

Before you start, make sure the following tools are installed on your system to run the project:

Git: Version control system to clone the project repository Download Git
Docker: To containerize the application and ensure it runs consistently across different environments Download Docker

Usage

To run the project, run the following command from the root directory of the project:

docker compose up --build

if (on windows) it has issues with port permissions do

net stop winnat
docker compose up --build
net start winnat

The "--build" flag on the docker command is to rebuild the images with any code changes. It's strictly not necessary if you're not modifying code.

Testing

To run the test suite, run the following command from the root directory of the project:

Documentation

Developer Setup

Team

This project would not have been possible without the hard work and dedication of all of the contributors. Thank you for the time and effort you have put into making this project a reality.