Skip to content
This repository has been archived by the owner on Mar 21, 2018. It is now read-only.

rijkvanzanten/robat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Logo

πŸ€– OBA Chatbot @ robat.rijks.website πŸ€–

Robat

Build Status NPM Robat

Robat is a chatbot which can help you with all most some of your questions regarding Amsterdam Public Library (OBA).

πŸ“– Introduction

Robat is a web-based chatbot which (from any device) can answer questions about the Amsterdam Public Library.

Please note: the whole UI is in dutch πŸ‡³πŸ‡±

Some questions you can ask/tell Robat:

  • Het wijzigen, aanvragen en de prijzen van een lidmaatschap.
  • Het verlengen van materiaal
  • Opvragen locaties van de OBA (inclusief google maps link)
  • Openingstijden van OBA locatie
  • Contactinformatie van een OBA locatie
  • Het kwijtraken van je pas

To view a full in-depth report of this project you can view the GitBook of this project.

βš™οΈ Installation & Development

Tech Stack

Prerequisites

  • Make sure you have node installed on your machine.

Installation

  1. Clone this repo
$ https://github.com/rijkvanzanten/robat.git
  1. Run npm install to install all dependencies.

After the installation, the application should automagically build the client-side assets. If this for some reason failed run npm run build.

You will need a .env file in the root of your project which contains a (server) Wit AI key and a public/secret keypair for the OBA API:

WIT_KEY=1234567890
OBA_PUBLIC=1234567890
OBA_SECRET=1234567890

Usage

  • To start the app, run npm start.
  • To run the app in development mode (with auto rebuilding), run npm run dev.
  • To test your code for linting errors, run npm test.

βœ… Todo's / ✨ Wishlist

To see all upcoming todo's and features please navigate to the issues page of this repo.

  • Add send/read indicators (like WhatsApp)
  • Show dates send/received
  • Show online / offline indicator
  • Search for activities within the oba
  • Support whole OBA FAQ in conversation
  • Multilingual support

πŸ“„ Contributing

Please read Contributing for details on how to contribute to this project. To see a list of everybody who participated go to the Contributors page.

When you do, please also view the Code of Conduct for this project.

Core Team

Rijk van Zanten Giulia Meerman Danny de Vries Mirza van Meerwijk Pierre Bleeker
Rijk van Zanten Giulia Meerman Danny de Vries Mirza van Meerwijk Pierre Bleeker

πŸ“ƒ License

This project is licensed under the MIT License