mirror of https://github.com/leon-ai/leon.git synced 2024-12-18 14:21:32 +03:00

🧠 Leon is your open-source personal assistant.

Go to file

Louistiti 182089b57a test(package/calendar): done		2019-06-06 23:15:33 +08:00
.circleci	chore: init	2019-02-10 20:26:50 +08:00
.github	chore: add "docker:check" npm script	2019-05-12 09:21:58 +08:00
app	feat(package/calendar): WIP done	2019-06-06 18:05:52 +08:00
bin	chore: init	2019-02-10 20:26:50 +08:00
bridges	test(package/calendar): done	2019-06-06 23:15:33 +08:00
core	refactor(server): actions to fallbacks	2019-05-04 11:20:35 +08:00
downloads	chore: init	2019-02-10 20:26:50 +08:00
hotword	chore: init	2019-02-10 20:26:50 +08:00
logs	chore: init	2019-02-10 20:26:50 +08:00
packages	test(package/calendar): done	2019-06-06 23:15:33 +08:00
scripts	test(package/calendar): done	2019-06-06 23:15:33 +08:00
server/src	feat(package/calendar): finalize English translation	2019-06-06 18:49:20 +08:00
test	test(server): NER done	2019-05-11 23:37:59 +08:00
.babelrc	chore: init	2019-02-10 20:26:50 +08:00
.changelogrc	chore: init	2019-02-10 20:26:50 +08:00
.dockerignore	fix: Leon was not fully installed with Docker if a `.env` file was existing	2019-03-10 09:47:37 +08:00
.editorconfig	chore: init	2019-02-10 20:26:50 +08:00
.env.sample	docs: add configuration docs URL in the dotenv file	2019-05-13 08:07:38 +08:00
.eslintrc.json	chore: init	2019-02-10 20:26:50 +08:00
.gitignore	feat(package/checker): Add test for haveibeenpwned module	2019-04-17 12:00:54 +01:00
CHANGELOG.md	chore: use right release tags to compare	2019-04-24 07:19:01 +08:00
Dockerfile	Don't upgrade pip, optimize pip3 install, remove build-base	2019-05-11 16:24:27 +02:00
ide.js	chore: init	2019-02-10 20:26:50 +08:00
LICENSE.md	chore: init	2019-02-10 20:26:50 +08:00
package-lock.json	chore: upgrade node-nlp to latest	2019-05-06 18:56:30 +08:00
package.json	chore: add "docker:check" npm script	2019-05-12 09:21:58 +08:00
README.md	chore: add "docker:check" npm script	2019-05-12 09:21:58 +08:00

README.md

Leon

Your open-source personal assistant.

Website :: Documentation :: Roadmap :: Contributing :: Story

Introduction

Leon is an open-source personal assistant who can live on your server.

He does stuff when you ask him for.

You can talk to him and he can talk to you. You can also text him and he can also text you. If you want to, Leon can communicate with you by being offline to protect your privacy.

Why?

If you are a developer (or not), you may want to build many things that could help in your daily life. Instead of building a dedicated project for each of those ideas, Leon can help you with his packages/modules (skills) structure.

With this generic structure, everyone can create their own modules and share them with others. Therefore there is only one core (to rule them all).

Leon uses AI concepts, which is cool.

Privacy matters, you can configure Leon to talk with him offline. You can already text with him without any third party services.

Open source is great.

What is this repository for?

This repository contains the following nodes of Leon:

The server

The packages/modules

The web app

The hotword node

What is Leon able to do?

Today, the most interesting part is about his core and the way he can scale up. He is pretty young but can easily scale to have new features (packages/modules). You can find what he is able to do by browsing the packages list.

Sounds good for you? Then let's get started!

Getting Started

Prerequisites

Node.js 10 or 11
npm >= 5
Python 3.6.x
Pipenv
Supported OSes: Linux, macOS and Windows

To install these prerequisites, you can follow the How To section of the documentation.

Installation

# Clone the repository (stable branch)
git clone -b master https://github.com/leon-ai/leon.git leon
# OR download the latest release at: https://github.com/leon-ai/leon/releases/latest

# Go to the project root
cd leon

# Install
npm install

Usage

# Check the setup went well
npm run check

# Build
npm run build

# Run
npm start

# Go to http://localhost:1337
# Hooray! Leon is running

Docker Installation

# Build
npm run docker:build

# Run on Linux or macOS
npm run docker:run

# Run on Windows (you can replace "UTC" by your time zone)
docker run -e TZ=UTC -p 1337:1337 -it leonai/leon

# Go to http://localhost:1337
# Hooray! Leon is running

Documentation

For full documentation, visit docs.getleon.ai.

Roadmap

To know what is going on, follow roadmap.getleon.ai.

Contributing

If you have an idea for improving Leon, do not hesitate.

Leon needs open source to live, the more modules he has, the more skillful he becomes.