From f66a6587382e7de82beff6e44d54921507cd50c5 Mon Sep 17 00:00:00 2001 From: Sally McGrath Date: Mon, 23 Sep 2024 13:41:03 +0100 Subject: [PATCH] split developing and workshop into two files --- DEVELOPING.md | 32 ++++++++++++++++++++++++++++++++ README.md | 33 --------------------------------- 2 files changed, 32 insertions(+), 33 deletions(-) create mode 100644 DEVELOPING.md diff --git a/DEVELOPING.md b/DEVELOPING.md new file mode 100644 index 0000000..f25e966 --- /dev/null +++ b/DEVELOPING.md @@ -0,0 +1,32 @@ +## How to run locally +This is built using the [GOV.UK Prototype Kit](https://govuk-prototype-kit.herokuapp.com/docs). + +To run it locally, clone it down, run `npm install` and then `npm start`. It'll then tell you a port to go to in the browser. + +#### Alternatively run it via docker & docker-compose +Depends on [docker install](https://docs.docker.com/install/) and [docker-compose install](https://docs.docker.com/compose/install/) +1. `docker-compose build` +2. `docker-compose up` + +Or get a bash console where you can run `npm` cmds via the built container (ensure step 1 above is done) +`docker-compose run --rm --service-ports --entrypoint="bash" goose` + +Run the tests via docker +`docker-compose run --rm --entrypoint="npm run test" goose` + +## Suggesting changes +Feedback is welcome. Either [submit an issue](https://https://github.com/CodeYourFuture/CYF-Record-A-Goose-Project/issues), or [open a PR](https://github.com/CodeYourFuture/CYF-Record-A-Goose-Project/pulls). + +## Resources for further learning +- [Udacity Accessibility course](https://www.udacity.com/course/web-accessibility--ud891) - good for futhering knowledge about writing accessible code +- [GDS WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/) - good for helping you understand the Web Content Accessibility Guidelines +- [GDS guidance how to conduct a basic accessibility audit](https://www.gov.uk/government/publications/doing-a-basic-accessibility-check-if-you-cant-do-a-detailed-one/doing-a-basic-accessibility-check-if-you-cant-do-a-detailed-one) - mentioned above but listed here as well +- [a11y weekly](https://a11yweekly.com/) - a good weekly newsletter about accessibility + +Any other suggestions, free free to add them! + +## Other versions of the exercise +This version is forked (and revived) from the MoJ archived repo. Other forks: + +- [NHS Accessibility exercise](https://github.com/nhsuk/accessibility-training) +- [Coop accessibility exercise - 'Report a leaky bag of flour'](https://github.com/coopdigital/return-a-leaky-bag-of-flour) diff --git a/README.md b/README.md index a39bfd8..421a575 100644 --- a/README.md +++ b/README.md @@ -23,36 +23,3 @@ I would recommend working through the site in the following order: Government Digital Services have recently published [how to conduct a basic accessibility audit](https://www.gov.uk/government/publications/doing-a-basic-accessibility-check-if-you-cant-do-a-detailed-one/doing-a-basic-accessibility-check-if-you-cant-do-a-detailed-one), which is worth a look at too. Testing like this is a good way to identify basic accessibility issues. It would not replace an audit against WCAG 2.1 to level AA, and its ~50 criteria. Why still do it? These are tests that are quick to run, and it's easier to fix accessibility issues at the start, rather than the end. - -## How to run locally -This is built using the [GOV.UK Prototype Kit](https://govuk-prototype-kit.herokuapp.com/docs). - -To run it locally, clone it down, run `npm install` and then `npm start`. It'll then tell you a port to go to in the browser. - -#### Alternatively run it via docker & docker-compose -Depends on [docker install](https://docs.docker.com/install/) and [docker-compose install](https://docs.docker.com/compose/install/) -1. `docker-compose build` -2. `docker-compose up` - -Or get a bash console where you can run `npm` cmds via the built container (ensure step 1 above is done) -`docker-compose run --rm --service-ports --entrypoint="bash" goose` - -Run the tests via docker -`docker-compose run --rm --entrypoint="npm run test" goose` - -## Suggesting changes -Feedback is welcome. Either [submit an issue](https://https://github.com/CodeYourFuture/CYF-Record-A-Goose-Project/issues), or [open a PR](https://github.com/CodeYourFuture/CYF-Record-A-Goose-Project/pulls). - -## Resources for further learning -- [Udacity Accessibility course](https://www.udacity.com/course/web-accessibility--ud891) - good for futhering knowledge about writing accessible code -- [GDS WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/) - good for helping you understand the Web Content Accessibility Guidelines -- [GDS guidance how to conduct a basic accessibility audit](https://www.gov.uk/government/publications/doing-a-basic-accessibility-check-if-you-cant-do-a-detailed-one/doing-a-basic-accessibility-check-if-you-cant-do-a-detailed-one) - mentioned above but listed here as well -- [a11y weekly](https://a11yweekly.com/) - a good weekly newsletter about accessibility - -Any other suggestions, free free to add them! - -## Other versions of the exercise -This version is forked (and revived) from the MoJ archived repo. Other forks: - -- [NHS Accessibility exercise](https://github.com/nhsuk/accessibility-training) -- [Coop accessibility exercise - 'Report a leaky bag of flour'](https://github.com/coopdigital/return-a-leaky-bag-of-flour)