forked from IAdamAi/AdamAI
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
39 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,39 @@ | ||
# AdamAI | ||
# AdamAI | ||
|
||
[](https://travis-ci.com/IAdamAi/AdamAI) | ||
|
||
AdamAI is a chatbot to introduce people to Islam. Currently it has this main API repisotory which is deployed on Heroku. There is a [telegram bot](https://github.com/IAdamAi/AdamAI_telegram) in other repository which used this API to send responses. | ||
|
||
## Built With | ||
|
||
[Node Js](https://nodejs.org/en/) - Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. | ||
|
||
## Contributing | ||
|
||
Please feel free to contribute to this project by creating an issue first and then sending a pull request against the issue. | ||
|
||
## Installation | ||
|
||
It requires [Node.js](https://nodejs.org/) to run. Install it from the link and then in order to set it up locally follow below steps: | ||
|
||
```sh | ||
$ cd AdamAI | ||
$ npm install | ||
$ node app.js | ||
``` | ||
|
||
## Future Roadmap: | ||
|
||
We are hoping AdamAI to be fully equiped with following feature in future: | ||
|
||
* Both text and voice connversation. | ||
* Natural Language Processing (NLP) | ||
* Machine Learning (ML) | ||
* Question focused | ||
* Realtime conversation | ||
* User friendly | ||
* Able to answer off-topic questions smartly | ||
|
||
## License | ||
|
||
MIT |