|
1 |
| -<p align="center"> |
2 |
| - <a href="" rel="noopener"> |
3 |
| - <img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a> |
4 |
| -</p> |
5 |
| - |
6 |
| -<h3 align="center">Project Title</h3> |
7 |
| - |
8 |
| -<div align="center"> |
9 |
| - |
10 |
| -[]() |
11 |
| -[](https://www.reddit.com/user/Wordbook_Bot) |
12 |
| -[](https://github.com/kylelobo/The-Documentation-Compendium/issues) |
13 |
| -[](https://github.com/kylelobo/The-Documentation-Compendium/pulls) |
14 |
| -[](/LICENSE) |
15 |
| - |
16 |
| -</div> |
17 |
| - |
18 |
| ---- |
19 |
| - |
20 |
| -<p align="center"> 🤖 Few lines describing what your bot does. |
21 |
| - <br> |
22 |
| -</p> |
23 |
| - |
24 |
| -## 📝 Table of Contents |
25 |
| - |
26 |
| -- [About](#about) |
27 |
| -- [Demo / Working](#demo) |
28 |
| -- [How it works](#working) |
29 |
| -- [Usage](#usage) |
30 |
| -- [Getting Started](#getting_started) |
31 |
| -- [Deploying your own bot](#deployment) |
32 |
| -- [Built Using](#built_using) |
33 |
| -- [TODO](../TODO.md) |
34 |
| -- [Contributing](../CONTRIBUTING.md) |
35 |
| -- [Authors](#authors) |
36 |
| -- [Acknowledgments](#acknowledgement) |
37 |
| - |
38 |
| -## 🧐 About <a name = "about"></a> |
39 |
| - |
40 |
| -Write about 1-2 paragraphs describing the purpose of your bot. |
41 |
| - |
42 |
| -## 🎥 Demo / Working <a name = "demo"></a> |
43 |
| - |
44 |
| - |
45 |
| - |
46 |
| -## 💭 How it works <a name = "working"></a> |
47 |
| - |
48 |
| -The bot first extracts the word from the comment and then fetches word definitions, part of speech, example and source from the Oxford Dictionary API. |
49 |
| - |
50 |
| -If the word does not exist in the Oxford Dictionary, the Oxford API then returns a 404 response upon which the bot then tries to fetch results form the Urban Dictionary API. |
51 |
| - |
52 |
| -The bot uses the Pushshift API to fetch comments, PRAW module to reply to comments and Heroku as a server. |
53 |
| - |
54 |
| -The entire bot is written in Python 3.6 |
55 |
| - |
56 |
| -## 🎈 Usage <a name = "usage"></a> |
57 |
| - |
58 |
| -To use the bot, type: |
| 1 | +# jjgaming |
59 | 2 |
|
| 3 | +## Project setup |
60 | 4 | ```
|
61 |
| -!dict word |
| 5 | +npm install |
62 | 6 | ```
|
63 | 7 |
|
64 |
| -The first part, i.e. "!dict" **is not** case sensitive. |
65 |
| - |
66 |
| -The bot will then give you the Oxford Dictionary (or Urban Dictionary; if the word does not exist in the Oxford Dictionary) definition of the word as a comment reply. |
67 |
| - |
68 |
| -### Example: |
69 |
| - |
70 |
| -> !dict what is love |
71 |
| -
|
72 |
| -**Definition:** |
73 |
| - |
74 |
| -Baby, dont hurt me~ |
75 |
| -Dont hurt me~ no more. |
76 |
| - |
77 |
| -**Example:** |
78 |
| - |
79 |
| -Dude1: Bruh, what is love? |
80 |
| -Dude2: Baby, dont hurt me, dont hurt me- no more! |
81 |
| -Dude1: dafuq? |
82 |
| - |
83 |
| -**Source:** https://www.urbandictionary.com/define.php?term=what%20is%20love |
84 |
| - |
85 |
| ---- |
86 |
| - |
87 |
| -<sup>Beep boop. I am a bot. If there are any issues, contact my [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)</sup> |
88 |
| - |
89 |
| -<sup>Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup> |
90 |
| - |
91 |
| -## 🏁 Getting Started <a name = "getting_started"></a> |
92 |
| - |
93 |
| -These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. |
94 |
| - |
95 |
| -### Prerequisites |
96 |
| - |
97 |
| -What things you need to install the software and how to install them. |
98 |
| - |
| 8 | +### Compiles and hot-reloads for development |
99 | 9 | ```
|
100 |
| -Give examples |
| 10 | +npm run serve |
101 | 11 | ```
|
102 | 12 |
|
103 |
| -### Installing |
104 |
| - |
105 |
| -A step by step series of examples that tell you how to get a development env running. |
106 |
| - |
107 |
| -Say what the step will be |
108 |
| - |
| 13 | +### Compiles and minifies for production |
109 | 14 | ```
|
110 |
| -Give the example |
| 15 | +npm run build |
111 | 16 | ```
|
112 | 17 |
|
113 |
| -And repeat |
114 |
| - |
| 18 | +### Lints and fixes files |
115 | 19 | ```
|
116 |
| -until finished |
| 20 | +npm run lint |
117 | 21 | ```
|
118 | 22 |
|
119 |
| -End with an example of getting some data out of the system or using it for a little demo. |
120 |
| - |
121 |
| -## 🚀 Deploying your own bot <a name = "deployment"></a> |
122 |
| - |
123 |
| -To see an example project on how to deploy your bot, please see my own configuration: |
124 |
| - |
125 |
| -- **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot |
126 |
| - |
127 |
| -## ⛏️ Built Using <a name = "built_using"></a> |
128 |
| - |
129 |
| -- [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper |
130 |
| -- [Heroku](https://www.heroku.com/) - SaaS hosting platform |
131 |
| - |
132 |
| -## ✍️ Authors <a name = "authors"></a> |
133 |
| - |
134 |
| -- [@kylelobo](https://github.com/kylelobo) - Idea & Initial work |
135 |
| - |
136 |
| -See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project. |
137 |
| - |
138 |
| -## 🎉 Acknowledgements <a name = "acknowledgement"></a> |
139 |
| - |
140 |
| -- Hat tip to anyone whose code was used |
141 |
| -- Inspiration |
142 |
| -- References |
| 23 | +### Customize configuration |
| 24 | +See [Configuration Reference](https://cli.vuejs.org/config/). |
0 commit comments