Skip to content

Commit 4074995

Browse files
committed
Add basic tests
1 parent 8311065 commit 4074995

File tree

6 files changed

+2550
-1
lines changed

6 files changed

+2550
-1
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
/.project
22
chrome/screenshot*.jpg
33
/pageaccel.zip
4+
node_modules
5+
npm-debug.log

.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
10.16.3

README.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ For users who prefer to use the standard (non-accelerated version) of pages on a
88

99
PageAccel is a free, community-driven open source project.
1010

11+
[How does this work?](#how-does-this-work)
12+
13+
[Installation](#installation)
14+
15+
[Development](#development)
16+
17+
- [Initial Setup](#initial-setup)
18+
- [Testing](#testing)
19+
20+
* * * * *
21+
1122
## How does this work?
1223

1324
Some websites provide alternative, streamlined versions of their pages called AMP (accelerated mobile pages). These pages are created to load faster and provide simplified content for both desktop and mobile users alike. When PageAccel detects that a page has an AMP version, it switches to use it.
@@ -18,11 +29,30 @@ PageAccel does *not* create any of its content, nor does it alter pages by itsel
1829

1930
Open the [PageAccel Home Page](http://pageaccel.raack.info) and click the installation button.
2031

32+
* * * * *
33+
34+
## Development
35+
36+
### Initial Setup
37+
38+
1. Install [Node.js](https://nodejs.org/en/).
39+
1. Install [NVM](https://github.com/creationix/nvm)
40+
1. `nvm install`
41+
42+
### Testing
43+
44+
1. `npm test`
45+
46+
* * * * *
47+
2148
## TODO
2249

2350
* Add "Send Feedback / Broken Page" item to menu to allow direct feedback, positive and negative. Include page currently on and message with feedback. Send this to [email protected].
2451
* Prompt user for feedback (rating, free text, or both) after having visted several simplified pages. Indicated to them which ones were simplified.
2552
* Register simplified and standard domains as pairs, in case they're different.
26-
* This may also alleviate the need for the tld domain list
53+
* This may also alleviate the need for the tld domain list
2754
* Remove unused tabs from storage if not used in last x days
2855
* Provide stats button in pageaccel so user can see stats anytime.
56+
* Add tests for what the Action Button in the browser panel looks like when loading an AMP page once Puppeteer supports this:
57+
* https://github.com/GoogleChrome/puppeteer/issues/2486
58+
* https://github.com/GoogleChrome/puppeteer/issues/1215

0 commit comments

Comments
 (0)