Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 3.38 KB

README.md

File metadata and controls

67 lines (44 loc) · 3.38 KB
Raw

MET-CS622-ChatBot-Project (Chat Bot)

An Android chat bot for MET CS622 final Project which queries smartwatch database to give user insights over their activity.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • Please fork the repository and work from it so that I can incoorporate the changes you make or if you add any new features.
  • You need to have the googleservices.json file to link to firebase, you can set it up using Set up Firebase or email me on ([email protected]) for further instructions.
  • You need to clone the backend for this project as well which you can find here MET-CS622-ChatBot-Backend. Instructions on how to clone it are given below.

Installing

git clone https://github.com/<your_username>/MET-CS622-ChatBot-Project.git

git clone https://github.com/<your_username>/MET-CS622-ChatBot-Project-Backend.git

  • Or you can fork this repository and then create a pull request for implementing the changes

  • If you want to install the release apk on your android device then go to the release tab of the repo, and download the apk from the latest release.

Deployment

  • All releases would be ready to be isntalled on supported android devices
  • This app is for education/research purpose only and hence won't be released on the playstore as of yet, prior announcement will be made.

Features

  • Run queries to database via chat messages.
  • Messages are stored both locally and on cloud.
  • User authentication allows any user to log in and retrieve previously typed messages and responses.
  • Built with MVVM hence easy to maintain, test and easy to pickup.

Built With

  • Firebase - A comprehensive mobile development platform, go serverless with firebase
  • Maven - Dependency Management
  • Git - Used for version control
  • FastAndroidNetworking - Used FAN API to call REST APIs
  • Timber - Used for logging

Contributing

Will update the requirements and code of conduct soon.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL License - see the LICENSE file for details