This is the University of York's Course Search application. It allows prospective students to search for courses, view results, and follow links to course pages. Both a live system and a test system are available.

See the wiki for architectural decisions and developer guides.

• Courses API - the API that provides Course Search functionality and in turn calls the Funnelback Courses API.
• Funnelback Courses API - the underlying Funnelback search provider configuration that powers searches.
• Pattern Library React Components - a suite of React components for incorporating university style into the application.

• You will need Node.js (v12) installed on your machine.
• You will need to have configured a .npmrc file with a GitHub token that has read access to packages from Pattern Library React Components.

This application uses Next.js. The entry point for the application is src/pages/index.js.

To build and run the application:

npm run dev

Once started, the system is accessible at http://localhost:3000.

Automated tests live in src/tests. To run them:

npm test

We use Percy for visual testing. This adds snapshots of UI changes to each pull request.

We use Lighthouse to run performance tests against the application on each new build and pull request. Performance scores below 85 are marked as a failing build.

We use the eslint-plugin-jsx-a11y to perform basic accessibility checks. We also run manual accessibility tests against the application, including testing with users of assistive technologies.

To reinforce an accessibility-first approach, we use ARIA roles and reference these in automated tests where possible.

This project uses Prettier for code formatting and XO for linting. To format the code and run these checks:

npm run fc

Deployment to the development and production environments happens through GitHub actions that trigger automatically when new code is merged into the dev and main branches. See the deployment wiki page for more details.

You can run Course Search in your own AWS account. You will need to do the following:

• Make sure you've got an active token under ~/.aws/credentials (e.g. by logging into your account with saml2aws)
• Define an environment variable called AWS_ACCOUNT_ID populated with your AWS account ID

Then run one of the following, depending on whether you want to query the development or production version of the Courses API:

npm run deploy:dev
npm run deploy

To undeploy the application from your AWS account:

npm run undeploy

• Digital Services Teaching and Learning Service Delivery Team