mirror of https://github.com/leon-ai/leon.git synced 2024-11-28 21:19:45 +03:00

🧠 Leon is your open-source personal assistant.

Go to file

louistiti 47e9c291b4 ci: remove Windows		2022-10-10 09:02:03 +08:00
.github	ci: remove Windows	2022-10-10 09:02:03 +08:00
.husky	chore: Prettier and lint-staged setup	2022-09-03 20:59:18 +08:00
app	fix(web app): when suggestions are null new npm deps tree was creating conflict	2022-09-04 23:48:55 +08:00
bin	chore: remove DeepSpeech binary folder; add Coqui binary folder to gitignore	2022-01-31 14:11:48 +08:00
bridges/python	feat(python bridge): versioning	2022-10-09 00:29:30 +08:00
core	chore: ignore core/skills-endpoints.json	2022-09-20 22:19:06 +02:00
downloads	chore: init	2019-02-10 20:26:50 +08:00
hotword	chore: upgrade hotword deps	2022-09-10 10:55:13 +08:00
logs	chore: init	2019-02-10 20:26:50 +08:00
scripts	refactor: exit pre-release binaries script	2022-10-09 23:58:59 +08:00
server/src	feat(server): add warning hint on macOS TCP server cold start	2022-10-07 19:18:36 +08:00
skills	refactor(server): make use of `node:*` import for all Node.js built-in modules	2022-09-26 23:28:25 +08:00
tcp_server	feat(tcp server): versioning	2022-10-09 00:31:52 +08:00
test	refactor(server): make use of `node:*` import for all Node.js built-in modules	2022-09-26 23:28:25 +08:00
.changelogrc	chore: init	2019-02-10 20:26:50 +08:00
.dockerignore	feat: Python bridge binary build with cx_Freeze	2022-10-04 14:19:56 +08:00
.editorconfig	chore: add Python config in EditorConfig	2021-04-04 12:41:25 +08:00
.env.sample	refactor: remove `LC_ALL` and `LANG` env vars	2022-10-07 18:23:10 +08:00
.eslintrc.json	chore: add `unicorn/prefer-node-protocol` ESLint rule	2022-09-26 22:10:27 +02:00
.gitignore	feat: isolate TCP server	2022-10-04 17:10:14 +08:00
.gitpod.yml	chore: improve Gitpod usage (using current source code) (#398 )	2022-07-30 17:20:40 +08:00
.lintstagedrc	feat: lint-staged config	2022-09-03 20:56:15 +08:00
.npmrc	chore: force mimimun Node.js requirement	2021-03-28 13:20:06 +08:00
.nvmrc	chore: create .nvmrc with latest LTS version	2021-03-28 13:21:32 +08:00
.prettierrc.json	feat: basic Prettier setup	2022-09-03 18:37:56 +08:00
CHANGELOG.md	feat: complete Prettier setup	2022-09-03 19:12:41 +08:00
docker-compose.dev.yml	fix(docker): usage of Ubuntu base image with pyenv and nvm (#408 )	2022-08-23 20:59:09 +08:00
docker-compose.yml	fix(docker): usage of Ubuntu base image with pyenv and nvm (#408 )	2022-08-23 20:59:09 +08:00
Dockerfile	fix(docker): usage of Ubuntu base image with pyenv and nvm (#408 )	2022-08-23 20:59:09 +08:00
jsconfig.json	chore: use jsconfig instead of IDE config	2022-01-25 20:20:49 +08:00
LICENSE.md	chore: change email address	2022-08-23 23:01:46 +08:00
nodemon.json	feat: complete Prettier setup	2022-09-03 19:12:41 +08:00
package-lock.json	feat: universal build binaries script	2022-10-07 10:41:04 +08:00
package.json	refactor: rename GitHub workflows release script as pre-release	2022-10-09 21:27:12 +08:00
README.md	chore: add TCP server and Python bridge as high-level nodes	2022-10-04 17:16:41 +08:00
tsconfig.json	chore: explicit exclusion of TCP server and Python bridge on TypeScript watcher	2022-10-07 15:47:55 +08:00

README.md

Leon

Your open-source personal assistant.

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

📢 Notice 📢

Many exciting things are coming up, hence no new documentation and test are going to be written until the official release of Leon. Feel free to join us on Discord to know more and to read the "A Much Better NLP and Future" blog post.

👋 Introduction

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

He does stuff when you ask him to.

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 Skills structure.

With this generic structure, everyone can create their own skills 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

Skills

The web app

The hotword node

The TCP server (for inter-process communication between Leon and third-party processes such as spaCy)

The Python bridge (the connector between Python core and skills)

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 (skills). You can find what he is able to do by browsing the skills list.
Please do know that after the official release, we will build many skills along with the community. Feel free to join us on Discord to be part of the journey.

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

☁️ Try with a Single-Click

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

🚀 Getting Started

Prerequisites

Node.js >= 16
npm >= 8
Supported OSes: Linux, macOS and Windows

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

Installation

# 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

# Check the setup went well
leon check

# Run
leon start

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

Docker Installation

# 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.

📺 Video

Watch a demo.

🧭 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 skills 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 (@grenlouis)

👍 Sponsors

Anonymous
_{^{100 USD / month}}

phareal
_{^{30 USD / month}}

Keith Myers
_{^{10 USD / month}}

You?

You can also contribute by sponsoring Leon.

Please note that I dedicate most of my free time to Leon.

By sponsoring the project you make the project sustainable and faster to develop features.

The focus is not only limited to the activity you see on GitHub but also a lot of thinking about the direction of the project. Which is naturally related to the overall design, architecture, vision, learning process and so on...

Special Thanks

📝 License

MIT License