Skip to content

Latest commit

 

History

History
165 lines (114 loc) · 5.29 KB

README.md

File metadata and controls

165 lines (114 loc) · 5.29 KB
Raw




Leon

Your open-source personal assistant.

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

Note

Attendees of the "Strategies for creating your own conversational test assistant with Robot Framework and other tools" workshop for RoboCon 2020 should proceed to the following link... https://github.com/jg8481/leon/tree/develop/packages/robotframework-test-assistant

Here is a RoboCon 2020 demonstration of this conversational test assistant... https://youtu.be/oo11OlAaWWA

Introduction

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

He does stuff when you ask him.

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?

  1. 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.
  2. 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).
  3. Leon uses AI concepts, which is cool.
  4. Privacy matters, you can configure Leon to talk with him offline. You can already text with him without any third party services.
  5. 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

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.

The Story Behind Leon

You'll find a write-up on this blog post.

Stay Tuned

Author

Louis Grenard (@louistiti_fr)

Donate

You can also contribute by buying Louis Grenard a fruit juice.

License

MIT License

Copyright (c) 2019-present, Louis Grenard [email protected]

Cheers!

Cheers!