{"id":23066983,"url":"https://github.com/dvsa/vehicle-recalls-api","last_synced_at":"2025-08-15T11:33:48.066Z","repository":{"id":42318292,"uuid":"105773325","full_name":"dvsa/vehicle-recalls-api","owner":"dvsa","description":"Repository for Vehicle Recalls API","archived":false,"fork":false,"pushed_at":"2023-10-19T19:37:57.000Z","size":1219,"stargazers_count":2,"open_issues_count":18,"forks_count":2,"subscribers_count":38,"default_branch":"master","last_synced_at":"2024-04-15T04:43:12.199Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dvsa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-04T13:42:19.000Z","updated_at":"2024-01-03T09:17:53.000Z","dependencies_parsed_at":"2023-01-26T19:16:17.895Z","dependency_job_id":null,"html_url":"https://github.com/dvsa/vehicle-recalls-api","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fvehicle-recalls-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fvehicle-recalls-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fvehicle-recalls-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvsa%2Fvehicle-recalls-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dvsa","download_url":"https://codeload.github.com/dvsa/vehicle-recalls-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229910956,"owners_count":18143229,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-16T05:15:46.577Z","updated_at":"2024-12-16T05:15:47.112Z","avatar_url":"https://github.com/dvsa.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vehicle recalls api service\nVehicle recalls api service written in Node.js and deployed as a lambda function on AWS.\n\n# [Software Development Quality Assurance Policy](docs/NodejsDevQuality.md)\n\n# [Vehicle recalls service configuration](docs/ServiceConfiguration.md)\n\n# Documentation\n### Get vehicle recall\n\n* Endpoint used to verify if vehicle has outstanding recall\n```\nGET /recalls?make=MakeToCheck\u0026vin=vehicleVinNumber\n```\n\n# HTTP response codes:\n### 200\n* OK -\u003e Outstanding recall\n* OK -\u003e No outstanding recall\n\n### 400\n* Bad request -\u003e vin or make is not provided\n\n### 422\n* SMMT return information that provided VIN is invalid\n* SMMT return information that provided MAKE is invalid\n\n### 403\n* SMMT return unauthorized error (invalid SMMT api key -\u003e env variable: SMMT_API_KEY)\n\n### 500\n* Recall service is using incorrect SMMT uri (env variable: SMMT_API_URI)\n\n##\n### How to start\n\n* Clone repo\n* Go to app folder\n* Execute command\n```\nnpm install\n```\n* Execute command\n```\nnpm start\n```\n\nIt will start express.js app on localhost port 3000\n\n##\n### How to develop\n\n* Download Visual Studio Code\n```\nbrew cask visual-studio-code\n```\n* Execute command\n```\nnpm install\n```\n* Start npm watchers in Visual Studio Code terminals\n```\nnpm run test:watch\nnpm run lint:watch\n```\n\n##\n### Debug logs\nIf ``` debug ``` log level is set then additional information will be stored in logs:\n* Full request received by service\n* Correct SMMT responses received by service\n\n##\n### Provided npm commands\n* npm start -\u003e It will start web app on localhost:3000 using debug api key and any change will reload server (thx to [nodemon](https://github.com/remy/nodemon))\n* npm test -\u003e It will execute unit, integration tests and unit tests code coverage check.\n* npm run test:watch -\u003e It starts a file watcher that triggers tests if any of the files have changed\n* npm run retire -\u003e It will check libraries for safety\n* npm run lint -\u003e It will trigger JavaScript code style check (esLint)\n* npm run lint:watch -\u003e It will start file watcher and trigger esLint if any change is detected\n* npm run report -\u003e Generate tests coverage report (check app/coverage/index.html for details)\n* BUILDSTAMP=\"BuildNumber\" npm run build -\u003e Execute eslint, retire check, tests and create release zip package in app/dist/ folder","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdvsa%2Fvehicle-recalls-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdvsa%2Fvehicle-recalls-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdvsa%2Fvehicle-recalls-api/lists"}