Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.62 KB

README.md

File metadata and controls

44 lines (34 loc) · 2.62 KB

Tobito · Ask your Repository Dialogflow Adapter

Coverage Status

This repo is part of the "Ask your Repository" Bachelor project containing the following repos:

Setup

  1. Install YARN: https://yarnpkg.com/lang/en/docs/install/
  2. Clone the repository: git clone https://github.com/hpi-sam/ask-your-repository-dialogflow-adapter.git
  3. Change directory into the repository folder: cd ask-your-repository-dialogflow-adapter
  4. Execute yarn install to install dependencies
  5. Execute yarn flow-typed install to install types for all dependencies
  6. Start developing and Have fun!
  7. ???
  8. Profit!

Preconfigured project commands

If you have a look at the package.json you can see quite a few preconfigured 'scripts'.
The most important one is yarn start. This basically executes everything you could wish for:

  • Automatically starts builds on file change
  • Automatically restarts the server on file change
  • Automatically executes tests on file change
  • Automatically runs ESLint on file change
  • Automatically runs flow type check on file change

If you want to only do one of the above you can use: yarn build, yarn serve, yarn test, yarn lint, yarn flow respectively.
For test and lint the commands yarn tdd and yarn ldd start a watcher to run them automatically on file change. yarn build and yarn serve are always running with a watcher.

Major Dependencies

We use the actions on google library to manage out interaction with Dialogflow. Our interaction with the backend Elija server is managed with simple axios requests found here.

Documentation

Further documentation can be found in the Wiki.

License

This project is licensed under the terms of the MIT license.