https://github.com/dvsa/ftts-cancellation-api
https://github.com/dvsa/ftts-cancellation-api
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dvsa/ftts-cancellation-api
- Owner: dvsa
- Created: 2022-12-07T10:01:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-01T16:20:00.000Z (over 3 years ago)
- Last Synced: 2025-04-03T09:13:55.496Z (about 1 year ago)
- Language: TypeScript
- Size: 121 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FTTS Cancellation Api
This API application is responsible for the orchestration of the booking cancellation process.
See `https://dvsa.atlassian.net/wiki/spaces/FB/pages/68255863/0016.+Cancellation+API#Problem-Statements` for further details.
## Runtime
NodeJS >=16.x
## Language
Typescript 4.8.x
## Build and run
### Install packages
```bash
npm install
```
### Run the app locally via Azure CLI tools
Create a local.settings.json by running:
```bash
npm run copy-config
```
Run the api locally
```bash
npm run func:start
```
Clean installs, builds and runs the app. hosted at `http://localhost:7072/api/v1/cancel`
### Clean build the app
```bash
npm run build
```
### Generate coverage report
```bash
npm run test:coverage