-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ab8792b
commit adf0a96
Showing
1 changed file
with
6 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,12 @@ | ||
| # IDRC WCAG Reporter | ||
|
|
||
| This repository lets you create WCAG Audit Reports from Markdown files. It is based on [Eleventy WCAG Reporter](https://github.com/hidde/eleventy-wcag-reporter) | ||
|  | ||
|  | ||
|  | ||
|
|
||
| The IDRC WCAG Reporter lets you create WCAG Audit Reports from Markdown files. It is based on [Eleventy WCAG Reporter](https://github.com/hidde/eleventy-wcag-reporter) | ||
| by Hidde de Vries. | ||
|
|
||
| ## Usage | ||
|
|
||
| ### To run locally in development mode | ||
|
|
||
| 1. Install the required NPM packages: `npm install` | ||
| 2. Run [Eleventy](http://11ty.dev) in development mode: `npm start`. | ||
|
|
||
| The website will be available at [http://localhost:8080](http://localhost:8080). | ||
|
|
||
| ### To build and serve using Docker | ||
|
|
||
| You can build and serve the website from a [Docker](https://docs.docker.com/get-docker) container. | ||
|
|
||
| Once you have Docker installed, run the following commands to build a Docker image and start a container: | ||
|
|
||
| * Build the image: `docker build -t idrc-wcag-reporter .` | ||
| * Run the container: `docker run --name idrc-wcag-reporter -p 8000:80 idrc-wcag-reporter` | ||
|
|
||
| The website will be available at [http://localhost:8000](http://localhost:8000) | ||
|
|
||
| If you make changes to the website, repeat the steps to build the image and start a new container. | ||
|
|
||
| ### To build for deployment to a personal web server | ||
|
|
||
| 1. Install the required NPM packages: `npm install` | ||
| 2. Run the build script: `npm run build` | ||
| 3. Upload the contents of the `./_site/` directory to the web root of your server. | ||
|
|
||
| If you make changes to the website, repeat step 2 to build the website and upload any changed files from the `./_site/` | ||
| directory to the web root of your server. | ||
| For usage instructions, [consult the wiki](https://github.com/inclusive-design/idrc-wcag-reporter/wiki). |