HeyHeyChicken/NOVA

NOVA is a customizable personal assistant made with Node.js.

👋 Introduction

NOVA is an open-source personal assistant that you can host on your server.
You can communicate with it orally or in writing, most of his skills are designed to work offline to protect your privacy.

☁️ Try with a Single-Click

Gitpod will automatically setup an environment and run an instance for you.

❗ The server and client pages will not open automatically, click the " Remote Explorer " button (on the left side panel), then the " Open Browser " button for ports "8080" and "8083".

🔧 Prerequisites

Node.js
npm
Git

⬇️ Installation

1. Clone it directly from GitHub.

git clone https://github.com/HeyHeyChicken/NOVA.git

2. Install packages

cd NOVA

npm install

🚀 Usage

1. Launch this command.

node index.js

2. If you start the launcher for the first time, it will ask you if you want to launch a client or/and a server.
   If you need to change it in the future, you'll have to edit the "/settings.json".

If you want more detailed explanations, you will find them on the Wiki.

💼 Features

When you install NOVA, no features are installed. You need to add them.

1. Go to your NOVA's server UI (the default URL is "http://localhost:8080/")
2. Go to the "Skills" tab.
3. Find skills you want, open the modal and click on the "Install" button.
   The server and clients will restarts, and the skill will be installed.

🫵 Support and contribution

I provide support for all users through GitHub issues.

If you would like to contribute to this project, make sure you first read the guide for contributors.

⭐ Stars

Thank you to everyone who has and who will starred this project.

💻 Compatibility

NOVA has only been officially tested on Mac, Linux and Raspberry Pi 4.

📦 A great case

Hey, I made a case for my NOVA hosted in a Raspberry PI 4.
You can find the SketchUp plan in NOVA/resources/NOVA_SketchUp_Case.skp.

Created by Antoine Duval (HeyHeyChicken) with ❤ and ☕ (chocolate) in Mesnil-Panneville.