Git Product home page Git Product logo

olivia's Introduction


Olivia's character

๐Ÿ’โ€โ™€๏ธ Your new best friend

GoDoc

Twitter Follow

Website โ€” Documentation โ€” Getting started โ€” Introduction โ€” Translations โ€” Contributors โ€” License

โš ๏ธ Please check the Call for contributors

Introduction

introduction

Description

Olivia is an open-source chatbot built in Golang using Machine Learning technologies. Its goal is to provide a free and open-source alternative to big services like DialogFlow.

You can chat with her by speaking (STT) or writing, she replies with a text message but you can enable her voice (TTS).

You can clone the project and customize it as you want using GitHub Try it on her website!

Why Olivia?

  • The only chatbot project in Go that could be modulable and customizable.
  • Using daily a privacy-friendly chatbot is great.
  • The Website is a Progressive Web Application, which means you can add it to your phone and it seems like a native app!

Getting started

Installation

Login to Github

To get a personal access token from Github go to Setings > Developer settings > Personal Access Tokens

Click on Generate new Token and name it you MUST have read and write packages ticked on. Then click Generate new token

Replace TOKEN with the Token that you just made.

$ export PAT=TOKEN

Login to Github (Note: change USERNAME to Gthub username)

$ echo $PAT | docker login docker.pkg.github.com -u USERNAME --password-stdin

Docker

docker installation

Pull the image from GitHub Packages

$ docker pull docker.pkg.github.com/olivia-ai/olivia/olivia:latest

Then start it

$ docker run -d -p 8080:8080 docker.pkg.github.com/olivia-ai/olivia/olivia:latest

You can just use the websocket of Olivia now.

To stop it, get the container id:

$ docker container ls
CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS                    NAMES
311b3abb963a        olivia              "./main"            7 minutes ago       Up 7 minutes        0.0.0.0:8080->8080/tcp   quizzical_mayer

and stop it

$ docker container stop 311b3abb963a 

The app will automatically check for res/datasets/training.json file which contains the save of the neural network. By default when you clone the repository from Github you have a stable save. If you want to train a new model just delete this file and rerun the app.

GitHub

Clone the project via GitHub:

$ git clone [email protected]:olivia-ai/olivia.git

Then download the dependencies

$ go mod download

And run it

$ go run main.go

Frontend and Backend

To install the frontend and the backend together, please use the docker-compose.yml file:

$ docker-compose up

And all done!

Architecture

architecture

Translations

introduction

Languages supported

  • English
  • Spanish
  • Catalan
  • French
  • German
  • Italian
  • Brazilian portuguese - not completed

Coverage

The coverage of the translations is given here. To add a language please read the documentation for that.

Contributors

docker installation

Contributing

Please refer to the contributing file

Code Contributors

Thanks to the people who contribute to Olivia.

Contribute

Financial Contributors

Become a financial contributor and help Olivia growth.

Contribute on the GitHub page of hugolgst โค๏ธ

License

FOSSA Status

Made with โค๏ธ by Hugo Lageneste

Olivia's wave

olivia's People

Contributors

a-yamout avatar aiden01 avatar aury88 avatar cvhariharan avatar fossabot avatar hugolgst avatar kellydanma avatar luqman-v1 avatar martijndeb avatar milouk avatar mschneider82 avatar muesli avatar popzhangzhi avatar quentinwidlocher avatar rafaelcpalmeida avatar realpixelcode avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.