Diff of /README.md [000000] .. [507a54]

Switch to unified view

a b/README.md
1
# NaBot Medical Chatbot :robot:
2
3
<div align="center">
4
5
![Chatbot Unit testing](https://github.com/MedBot-team/NaBot/actions/workflows/rasa-test.yml/badge.svg?style=svg)
6
![Action server workflow](https://github.com/MedBot-team/NaBot/actions/workflows/docker_push_actions.yml/badge.svg?style=svg)
7
![Chatbot server workflow](https://github.com/MedBot-team/NaBot/actions/workflows/docker_push_chatbot.yml/badge.svg?style=svg)
8
![Chatbot UI workflow](https://github.com/MedBot-team/NaBot/actions/workflows/docker_push_ui.yml/badge.svg?style=svg)
9
![Chatbot Monitoring workflow](https://github.com/MedBot-team/NaBot/actions/workflows/docker_push_monitoring.yml/badge.svg?style=svg)
10
11
</div>
12
13
<p align="center">
14
  <img src="https://github.com/Ali-Razmdideh/NaBot/blob/main/logo.png" />
15
</p>
16
17
NaBot is a smart medical chatbot. It can retrieve medicines and lab tests information for users just by chatting with it.
18
19
- Hey, NaBot, can you give me dosage information of Acetaminophen?
20
- Of course, I can! :wink:
21
22
We will support more features in the future. But now, we only support medicines and lab tests information.
23
24
# Test Chatbot
25
26
- Use website:
27
  - https://nabot.ml/
28
- Use Telegram channel
29
  - http://t.me/ask_nabot
30
31
# Use api
32
  - https://api.nabot.ml
33
34
# Test Monitoring tools
35
  - https://monitor.nabot.ml/
36
37
# List of NaBot features
38
39
You can find out a list of medicines, labs, and their information which we're supporting, in the following. 
40
41
* [List of medicines in our dataset](https://github.com/MedBot-team/NaBot/wiki/List-of-medicines)
42
* [List of lab tests in our dataset](https://github.com/MedBot-team/NaBot/wiki/List-of-lab-test)
43
* [List of information about medicines that NaBot supports](https://github.com/MedBot-team/NaBot/wiki/Medicines-information)
44
* [List of information about lab tests that NaBot supports](https://github.com/MedBot-team/NaBot/wiki/Lab-tests-information)
45
46
# Installation Guide
47
48
NaBot can be installed from its source code or by docker images. For more information, please read our [installation guide document](https://github.com/MedBot-team/NaBot/wiki/Installation-Guide).
49
50
# Contributing
51
52
If you have an idea for improving NaBot, or even if you want medicine or lab test information, which is not supported in NaBot yet, do not hesitate. Create an issue in GitHub. :heart:
53
54
NaBot needs an open-source contribution. The more features it has, the more skillful it becomes! 
55
56
# Credits
57
Our chatbot gets its power from the [Rasa](https://rasa.com/) engine. We are thankful to their team for their contribution to open-source society. :heart_eyes:
58
59
Our autocorrect component in the chatbot is based on [SymSpell](https://github.com/wolfgarbe/SymSpell), which medical and Persian dictionaries are added to it. We are thankful to their team for their contribution to open-source society. :heart_eyes:
60
61
UI of ourchatbot gets its power from [Streamlit](https://github.com/streamlit/streamlit). Thanks for their contribution to the open-source society. :heart_eyes:
62
63
A list of medicines information has been collected from [Drugs.com](https://www.drugs.com/) and [MedlinePlus](https://medlineplus.gov/druginformation.html). We're appreciating their teams for producing great medicines information. :hugs:
64
65
A list of lab tests information has been collected from [Lab tests online](https://labtestsonline.org/) and [MedlinePlus](https://medlineplus.gov/lab-tests/). We're appreciating their teams for producing great lab tests information. :hugs: