2019-02-10 15:26:50 +03:00
< p align = "center" >
< a href = "https://getleon.ai" > < img width = "96" src = "https://getleon.ai/img/logo.svg" > < / a > < br > < br >
< a href = "https://www.youtube.com/watch?v=p7GRGiicO1c" > < img width = "512" src = "https://getleon.ai/img/1.0.0-beta.0_preview_en.png" > < / a > < br >
< / p >
< h1 align = "center" > Leon< / h1 >
*< p align = "center" > Your open-source personal assistant.< / p > *
< p align = "center" >
< a href = "https://github.com/leon-ai/leon/blob/develop/LICENSE.md" > < img src = "https://img.shields.io/badge/license-MIT-blue.svg?style=flat" / > < / a >
< a href = "https://circleci.com/gh/leon-ai/leon/tree/develop" > < img src = "https://img.shields.io/circleci/project/github/leon-ai/leon.svg?style=flat" / > < / a >
< a href = "https://github.com/leon-ai/leon/blob/develop/.github/CONTRIBUTING.md" > < img src = "https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" / > < / a >
< / p >
< p align = "center" >
< a href = "https://getleon.ai" > Website< / a > ::
< a href = "https://docs.getleon.ai" > Documentation< / a > ::
< a href = "https://roadmap.getleon.ai" > Roadmap< / a > ::
2019-02-17 17:25:33 +03:00
< a href = "https://github.com/leon-ai/leon/blob/develop/.github/CONTRIBUTING.md" > Contributing< / a > ::
< a href = "https://blog.getleon.ai/the-story-behind-leon/" > Story< / a >
2019-02-10 15:26:50 +03:00
< / p >
---
## Introduction
Leon is an **open-source personal assistant** who can live **on your server** .
2019-02-23 13:39:06 +03:00
He **does stuff** when you **ask him for** .
2019-02-10 15:26:50 +03:00
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?
2019-03-30 07:23:59 +03:00
2019-02-10 15:26:50 +03:00
> 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.
2019-02-20 15:38:52 +03:00
> 2. With this generic structure, everyone can create their own modules and share them with others.
2019-02-18 14:18:17 +03:00
> Therefore there is only one core (to rule them all).
2019-02-10 15:26:50 +03:00
> 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.
2019-03-30 07:18:37 +03:00
> 5. Open source is great.
2019-02-10 15:26:50 +03:00
### What is this repository for?
2019-03-30 07:23:59 +03:00
2019-02-10 15:26:50 +03:00
> This repository contains the following nodes of Leon:
> - The server
> - The packages/modules
> - The web app
> - The hotword node
2019-03-30 07:23:59 +03:00
### 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](https://github.com/leon-ai/leon/tree/develop/packages).
2019-02-10 15:26:50 +03:00
Sounds good for you? Then let's get started!
## Getting Started
### Prerequisites
2019-04-30 02:45:53 +03:00
- [Node.js ](https://nodejs.org/ ) 10 or 11
2019-02-10 15:26:50 +03:00
- npm >= 5
- [Python ](https://www.python.org/downloads/ ) 3.6.x
- [Pipenv ](https://docs.pipenv.org )
- Supported OSes: Linux, macOS and Windows
To install these prerequisites, you can follow the [How To section ](https://docs.getleon.ai/how-to/ ) of the documentation.
### Installation
```sh
# 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
```sh
# Check the setup went well
npm run check
# Build
npm run build
# Run
npm start
# Go to http://localhost:1337
# Hooray! Leon is running
```
2019-02-23 16:27:28 +03:00
### Docker Installation
```sh
# Build
npm run docker:build
# Run
npm run docker:run
# Go to http://localhost:1337
# Hooray! Leon is running
```
2019-02-10 15:26:50 +03:00
## Documentation
For full documentation, visit [docs.getleon.ai ](https://docs.getleon.ai ).
## Roadmap
To know what is going on, follow [roadmap.getleon.ai ](https://roadmap.getleon.ai ).
## Contributing
2019-02-23 13:39:06 +03:00
If you have an idea for improving Leon, do not hesitate.
2019-02-10 15:26:50 +03:00
2019-03-30 07:18:37 +03:00
**Leon needs open source to live**, the more modules he has, the more skillful he becomes.
2019-02-10 15:26:50 +03:00
2019-02-17 17:25:33 +03:00
## The Story Behind Leon
You'll find a write-up on this [blog post ](https://blog.getleon.ai/the-story-behind-leon/ ).
2019-02-10 15:26:50 +03:00
## Stay Tuned
- [Newsletter ](https://getleon.ai )
- [Blog ](https://blog.getleon.ai )
- [GitHub issues ](https://github.com/leon-ai/leon/issues )
- [Twitter ](https://twitter.com/louistiti_fr )
- [#LeonAI ](https://twitter.com/hashtag/LeonAI )
## Author
**Louis Grenard** ([@louistiti_fr](https://twitter.com/louistiti_fr))
## Donate
You can also contribute by [buying me a fruit juice ](https://donate.getleon.ai ).
## License
[MIT License ](https://github.com/leon-ai/leon/blob/develop/LICENSE.md )
Copyright (c) 2019-present, Louis Grenard < louis.grenard @ gmail . com >
## Cheers!
![Cheers! ](https://assets-cdn.github.com/images/icons/emoji/unicode/1f37b.png?v6 "Cheers!" )