|
1 | 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> |
| 2 | + <img src="https://cloud.githubusercontent.com/assets/1268976/20607953/d7ae489c-b24a-11e6-9cc4-91c6c74c5e88.png"/> |
4 | 3 | </p> |
5 | | - |
6 | | -<h3 align="center">cypress</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> |
| 4 | +<p align="center"> |
| 5 | + <a href="https://on.cypress.io">Documentation</a> | |
| 6 | + <a href="https://on.cypress.io/changelog">Changelog</a> | |
| 7 | + <a href="https://on.cypress.io/roadmap">Roadmap</a> |
22 | 8 | </p> |
23 | 9 |
|
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 | | - |
| 10 | +<h3 align="center"> |
| 11 | + The web has evolved. Finally, testing has too. |
| 12 | +</h3> |
45 | 13 |
|
46 | | -## 💭 How it works <a name = "working"></a> |
| 14 | +<p align="center"> |
| 15 | + Fast, easy and reliable testing for anything that runs in a browser. |
| 16 | +</p> |
| 17 | +<p align="center"> |
| 18 | + Join us, we're <a href="https://cypress.io/jobs">hiring</a>. |
| 19 | +</p> |
47 | 20 |
|
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. |
| 21 | +<p align="center"> |
| 22 | + <a href="https://www.npmjs.com/package/cypress"> |
| 23 | + <img src="https://img.shields.io/npm/dm/cypress.svg" alt="npm"/> |
| 24 | + </a> |
| 25 | + <a href="https://gitter.im/cypress-io/cypress"> |
| 26 | + <img src="https://img.shields.io/gitter/room/cypress-io/cypress.svg" alt="Gitter chat"/> |
| 27 | + </a> |
| 28 | + <a href="https://stackshare.io/cypress"> |
| 29 | + <img src="https://img.stackshare.io/misc/follow-on-stackshare-badge.svg" alt="StackShare"/> |
| 30 | + </a><br /> |
| 31 | +</p> |
49 | 32 |
|
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. |
| 33 | +## What is Cypress? |
51 | 34 |
|
52 | | -The bot uses the Pushshift API to fetch comments, PRAW module to reply to comments and Heroku as a server. |
| 35 | +<p align="center"> |
| 36 | + <a href="https://player.vimeo.com/video/237527670"> |
| 37 | + <img alt="Why Cypress Video" src="https://user-images.githubusercontent.com/1271364/31739717-dbdff0ee-b41c-11e7-9b16-bfa1b6ac1814.png" width="75%" height="75%" /> |
| 38 | + </a> |
| 39 | +</p> |
53 | 40 |
|
54 | | -The entire bot is written in Python 3.6 |
| 41 | +## Installing |
55 | 42 |
|
56 | | -## 🎈 Usage <a name = "usage"></a> |
| 43 | +[](https://badge.fury.io/js/cypress) |
57 | 44 |
|
58 | | -To use the bot, type: |
| 45 | +Install Cypress for Mac, Linux, or Windows, then [get started](https://docs.cypress.io/guides/getting-started/installing-cypress.html). |
59 | 46 |
|
| 47 | +```bash |
| 48 | +npm install cypress --save-dev |
60 | 49 | ``` |
61 | | -!dict word |
| 50 | +or |
| 51 | +```bash |
| 52 | +yarn add cypress --dev |
62 | 53 | ``` |
63 | 54 |
|
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 |
| 55 | + |
71 | 56 |
|
72 | | -**Definition:** |
73 | 57 |
|
74 | | -Baby, dont hurt me~ |
75 | | -Dont hurt me~ no more. |
| 58 | +## Contributing |
76 | 59 |
|
77 | | -**Example:** |
| 60 | +- [](https://circleci.com/gh/cypress-io/cypress/tree/develop) - `develop` branch |
| 61 | +- [](https://circleci.com/gh/cypress-io/cypress/tree/master) - `master` branch |
78 | 62 |
|
79 | | -Dude1: Bruh, what is love? |
80 | | -Dude2: Baby, dont hurt me, dont hurt me- no more! |
81 | | -Dude1: dafuq? |
| 63 | +Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains repo organization, linting, testing, and other steps. |
82 | 64 |
|
83 | | -**Source:** https://www.urbandictionary.com/define.php?term=what%20is%20love |
| 65 | +## License |
84 | 66 |
|
85 | | ---- |
| 67 | +[](https://github.com/cypress-io/cypress/blob/master/LICENSE) |
86 | 68 |
|
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> |
| 69 | +This project is licensed under the terms of the [MIT license](/LICENSE). |
88 | 70 |
|
89 | | -<sup>Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup> |
| 71 | +## Badges |
90 | 72 |
|
91 | | -## 🏁 Getting Started <a name = "getting_started"></a> |
| 73 | +Let the world know your project is using Cypress.io to test with this cool badge |
92 | 74 |
|
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 | | - |
99 | | -``` |
100 | | -Give examples |
101 | | -``` |
102 | | - |
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 | | - |
109 | | -``` |
110 | | -Give the example |
111 | | -``` |
112 | | - |
113 | | -And repeat |
| 75 | +[](https://www.cypress.io/) |
114 | 76 |
|
115 | 77 | ``` |
116 | | -until finished |
| 78 | +[](https://www.cypress.io/) |
117 | 79 | ``` |
118 | | - |
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 |
0 commit comments