Skip to content

Commit e98f5f8

Browse files
authored
Merge pull request #168 from seleniumbase/organize-resources
Organize resources folder
2 parents 434d4ed + f0abd4a commit e98f5f8

22 files changed

+9
-1
lines changed

seleniumbase/resources/ReadMe.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
## Resources Help
22

3-
If you want to run SeleniumBase automation on local web pages while offline, that's possible if you copy the resource files here to a location where your local web server is able to access those files as long as you make the necessary updates to your local copy of SeleniumBase. You might not even need to use them depending on what you're doing.
3+
SeleniumBase uses some Javascript libraries for optional advanced features such as website tours, messenger, highlighting elements on a page, and other jQuery actions. In some cases, you may want to host these Javascript and CSS files from your own websites. For simplicity and convenience, these resources have been downloaded into the "resources" folder. If you decide to use your local versions, you may need to update the corresponding URLs in [base_case.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py).
4+
5+
Here are some of the resource files you'll find here:
46

57
**jquery-3.2.1.min.js** - This file is used by [base_case.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py) in activate_jquery(). The activate_jquery() method uses the version at [http://code.jquery.com/jquery-3.2.1.min.js](http://code.jquery.com/jquery-3.2.1.min.js). You only need this file if you're making jQuery calls in your automation (some base_case methods use jQuery).
68

79
**favicon.ico** - This file is used by [style_sheet.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/core/style_sheet.py) for the favicon icon. All it does is make the report page a little more professional-looking. Currently, SeleniumBase uses the version at [https://raw.githubusercontent.com/seleniumbase/SeleniumBase/master/seleniumbase/resources/favicon.ico](https://raw.githubusercontent.com/seleniumbase/SeleniumBase/master/seleniumbase/resources/favicon.ico).
10+
11+
**messenger/** - Files in this folder are used for creating Javascript notifications during test runs in Demo Mode.
12+
13+
**shepherd/** - Files in this folder are used for creating website tours using the Shepherd Javascript library.
14+
15+
**bootstrap_tour/** - Files in this folder are used for creating website tours using the Bootstrap Tour Javascript library. (SeleniumBase currently defaults to using Shepherd Tours.)

0 commit comments

Comments
 (0)