mirror of https://github.com/leon-ai/leon.git synced 2024-09-11 10:25:40 +03:00

🧠 Leon is your open-source personal assistant.

Go to file

louistiti 05a6c66205 chore: force mimimun Node.js requirement		2021-03-28 13:20:06 +08:00
.github	ci: add build and tests on pull_request	2021-03-22 20:23:43 +01:00
app	fix(web app): add back the main.js file	2021-03-16 21:39:47 +08:00
bin	chore: init	2019-02-10 20:26:50 +08:00
bridges	chore: set new Python dependencies tree	2021-03-28 13:07:06 +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	BREAKING(checker/haveibeenpwned): introduce v3 API with API key	2021-03-16 23:01:22 +08:00
scripts	chore: migrate from CircleCI to GitHub Actions	2021-03-21 14:58:14 +08:00
server/src	fix: set correct status code for GET /downloads	2021-03-22 21:09:43 +01:00
test	chore: migrate from express to fastify	2021-03-22 20:23:23 +01: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: init	2019-02-10 20:26:50 +08:00
.env.sample	refactor: remove web app env variables	2019-05-25 12:16:10 +08:00
.eslintrc.json	style: fix new linting	2021-03-16 01:39:52 +08:00
.gitignore	fix(web app): add back the main.js file	2021-03-16 21:39:47 +08:00
.npmrc	chore: force mimimun Node.js requirement	2021-03-28 13:20:06 +08:00
CHANGELOG.md	chore: use right release tags to compare	2019-04-24 07:19:01 +08:00
Dockerfile	chore: use node:14-alpine in Dockerfile	2021-03-07 12:39:07 +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	chore: migrate from express to fastify	2021-03-22 20:23:23 +01:00
package.json	chore: force mimimun Node.js requirement	2021-03-28 13:20:06 +08:00
README.md	docs(readme): add link to npm	2021-03-22 20:24:06 +01: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!

🚀 Getting Started

Prerequisites

Node.js >= 14
npm >= 5
Python >= 3
Pipenv
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 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.