2
2
3
3
# Accessibility Monitoring for Your Website
4
4
5
- AccessLint Monitor will alert you of accessibility errors in your website.
5
+ AccessLint.js warns you of accessibility errors in your website.
6
6
7
7
## Usage
8
8
9
- Install AccessLint Monitor by including the javascript in at the end of any page
10
- you want to monitor.
9
+ Install AccessLint.js by including the javascript in at the end of any page you
10
+ want to monitor.
11
+
12
+ Include the compiled library through the AccessLint CDN:
13
+
14
+ ```
15
+ <script src="http://cdn.accesslint.com/accesslint-0.1.js" type="text/javascript">
16
+ ```
11
17
12
18
## How it works
13
19
14
- AccessLint Monitor is similar to client side performance measurement tools like
15
- NewRelic or Google Analytics in the way it is included and run on your website.
16
20
When a visitor arrives at a page that has the script installed, an audit will
17
21
run in the background automatically. If there are any accessibility issues on
18
- that page, AccessLint Monitor track the error for review.
22
+ that page, AccessLint.js will raise the error and track it for review.
23
+
24
+ AccessLint.js runs assertions from the
25
+ [ aXe-core] ( https://github.com/dequelabs/axe-core ) accessibility library wherever
26
+ you include the script. It the raises JavaScript errors in the page and posts
27
+ results to the [ AccessLint service] ( https://beta.accesslint.com ) , where you can
28
+ add reporting and notification integrations.
19
29
20
30
## Development
21
31
@@ -26,22 +36,23 @@ code for inclusion clientside. It uses karma and mocha to run tests.
26
36
27
37
$ bin/setup
28
38
39
+ ### Testing
40
+
41
+ $ gulp
42
+
29
43
### Building
30
44
31
45
#### Development
32
46
33
- $ gulp build-dev
47
+ $ gulp build-dev # build and watch for changes
34
48
35
49
#### Production
36
50
37
51
$ gulp build
38
52
39
- ### Testing
40
-
41
- From the application root: ` $ karma start `
53
+ ### Deploying
42
54
43
- #### Smoke testing
55
+ AccessLint.js is hosted on Amazon S3 behind Cloudfront. You must have AWS
56
+ credentials with the AccessLint account to publish an updated version.
44
57
45
- 1 . Start the node test app ` $ DEBUG=express:* node test/integration/app.js ` .
46
- 1 . Visit ` localhost:3000 ` .
47
- 1 . Open the network panel and review the response from the host.
58
+ $ gulp publish
0 commit comments