mirror of https://github.com/leon-ai/leon.git synced 2024-11-24 04:31:31 +03:00

🧠 Leon is your open-source personal assistant.

Go to file

Louis Grenard 065225a7f5 docs(README): add special thanks		2021-12-07 22:44:22 +08:00
.github	refactor: prerequisites Node.js >= 16.0.0 and npm >= 8.0.0 (#322 )	2021-11-07 10:24:00 +08:00
app	docs: trim .html ext	2021-05-31 07:53:49 +08:00
bin	chore: init	2019-02-10 20:26:50 +08:00
bridges	chore: use different modules DBs while testing and flush them at the end of the tests	2021-04-05 11:46:42 +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(hotword): upgrade socket.io-client to 4.0.0	2021-03-16 15:04:09 +08:00
logs	chore: init	2019-02-10 20:26:50 +08:00
packages	docs: trim .html ext	2021-05-31 07:53:49 +08:00
scripts	chore: use different modules DBs while testing and flush them at the end of the tests	2021-04-05 11:46:42 +08:00
server/src	test(server): adjust server unit tests	2021-04-02 19:02:37 +08:00
test	chore: use different modules DBs while testing and flush them at the end of the tests	2021-04-05 11:46:42 +08:00
.babelrc	chore: upgrade to Babel 7+	2019-06-08 02:09:48 +08:00
.changelogrc	chore: init	2019-02-10 20:26:50 +08:00
.dockerignore	fix: take `.env` in consideration when using Docker	2019-06-06 09:06:48 +08:00
.editorconfig	chore: add Python config in EditorConfig	2021-04-04 12:41:25 +08:00
.env.sample	docs: trim .html ext	2021-05-31 07:53:49 +08:00
.eslintrc.json	style: fix new linting	2021-03-16 01:39:52 +08:00
.gitignore	refactor(server): switch from classifier to NLP model	2021-04-01 17:24:59 +08:00
.gitpod.yml	chore: add Gitpod (#238 )	2021-04-23 10:20:16 +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
CHANGELOG.md	build: release 1.0.0-beta.4	2021-05-01 21:34:00 +08:00
docker-compose.dev.yml	chore(docker-dev): ignore node_modules in the volume (#243 )	2021-05-08 10:37:26 +08:00
docker-compose.yml	chore(docker): fix docker in dev env and fix wrong LEON_PORT (#240 )	2021-04-28 12:01:26 +08:00
Dockerfile	refactor: prerequisites Node.js >= 16.0.0 and npm >= 8.0.0 (#322 )	2021-11-07 10:24:00 +08: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	refactor: prerequisites Node.js >= 16.0.0 and npm >= 8.0.0 (#322 )	2021-11-07 10:24:00 +08:00
package.json	refactor: prerequisites Node.js >= 16.0.0 and npm >= 8.0.0 (#322 )	2021-11-07 10:24:00 +08:00
README.md	docs(README): add special thanks	2021-12-07 22:44:22 +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!

☁️ 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
Python >= 3
Pipenv >= 2020.11.15
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
npm run docker:run

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

👍 Sponsors

Francaoz
_{^{100 USD / month}}

GrAMATO
_{^{30 USD / month}}

marvinpoo
_{^{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