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? > 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](https://github.com/leon-ai/leon/tree/develop/packages). Sounds good for you? Then let's get started! ## ☁️ Try with a Single-Click Gitpod will automatically setup an environment and run an instance for you. [](https://gitpod.io/#https://github.com/leon-ai/leon) ## 🚀 Getting Started ### Prerequisites - [Node.js](https://nodejs.org/) >= 16 - [npm](https://npmjs.com/) >= 8 - 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 # Install the Leon CLI npm install --global @leon-ai/cli # Install Leon (stable branch) leon create birth # OR install from the develop branch: leon create birth --develop ``` ### Usage ```sh # Check the setup went well leon check # Run leon start # Go to http://localhost:1337 # Hooray! Leon is running ``` ### Docker Installation ```sh # Install Leon leon create birth --docker # Run leon start # Go to http://localhost:1337 # Hooray! Leon is running ``` ## 📚 Documentation For full documentation, visit [docs.getleon.ai](https://docs.getleon.ai). ## 📺 Video [Watch a demo](https://www.youtube.com/watch?v=p7GRGiicO1c). ## 🧭 Roadmap To know what is going on, follow [roadmap.getleon.ai](http://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](https://blog.getleon.ai/the-story-behind-leon/). ## 🔔 Stay Tuned - [Twitter](https://twitter.com/grenlouis) - [Newsletter](http://newsletter.getleon.ai) - [Blog](https://blog.getleon.ai) - [GitHub issues](https://github.com/leon-ai/leon/issues) - [YouTube](https://www.youtube.com/channel/UCW6mk6j6nQUzFYY97r47emQ) - [#LeonAI](https://twitter.com/search?f=live&q=%23LeonAI%20(from%3Agrenlouis%20OR%20from%3Alouistiti_fr)&src=typed_query) ## 👨 Author **Louis Grenard** ([@grenlouis](https://twitter.com/grenlouis)) ## 👍 Sponsors
AOZ Studio
100 USD / month |
GrAMATO
17 USD / month |
phareal
17 USD / month |
Divlo
10 USD / month |
Keith Myers
10 USD / month |
You? |
## 📝 License
[MIT License](https://github.com/leon-ai/leon/blob/develop/LICENSE.md)
Copyright (c) 2019-present, Louis Grenard