Fallback: NHS Digital Webform

Table of Contents

• Introduction
• Requirements
• Installation
• Usage
• Building the Project
• Testing
• Contribution Guidelines
• License

Introduction

Fallback is a webform that can trigger deployment of our main website's pipeline to one of our environments. This project is intended to be used as a fallback mechanism when Slack is unavailable. The live version of the project can be found here. Note, this application is deshigned to be used by the Web Team; working creditionals are needed.

Requirements

• Node.js v14.x or higher
• NPM v7.x or higher

Installation

1. Clone the repository:

   git clone https://github.com/NHS-digital-website/fallback.git

2. Change directory:

   cd fallback

3. Install dependencies:

   npm install

Usage

To run the development server:

npm run dev

The application will then be served from http://localhost:5173/fallback.

Building the Project

To build the project, run:

npm run build

This will generate a dist/ directory containing the compiled assets ready for deployment.

Testing

To run unit tests:

npm run test:unit:

Contribution Guidelines

The main branch is protected. All changes must be done via a pull request (PR).

Fork the repository.

1. Create a new feature branch.
2. Make your changes and commit them.
3. Push the branch to your fork.
4. Open a pull request targeting the main branch for review.

License

This project is licensed under the MIT License - see the LICENSE file for details.