{"id":20038777,"url":"https://github.com/defra/aqie-back-end","last_synced_at":"2025-03-02T06:26:58.261Z","repository":{"id":224555617,"uuid":"763574654","full_name":"DEFRA/aqie-back-end","owner":"DEFRA","description":"Git repository for service aqie-back-end","archived":false,"fork":false,"pushed_at":"2025-02-11T17:12:54.000Z","size":308,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-11T18:26:48.611Z","etag":null,"topics":["backend","cdp","node","service"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DEFRA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-26T14:51:38.000Z","updated_at":"2025-02-11T17:11:51.000Z","dependencies_parsed_at":"2024-03-18T19:31:37.296Z","dependency_job_id":"3f3d7161-1510-48ed-a3e1-f4d3c380100b","html_url":"https://github.com/DEFRA/aqie-back-end","commit_stats":null,"previous_names":["defra/aqie-back-end"],"tags_count":82,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Faqie-back-end","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Faqie-back-end/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Faqie-back-end/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Faqie-back-end/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DEFRA","download_url":"https://codeload.github.com/DEFRA/aqie-back-end/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241469351,"owners_count":19968034,"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":["backend","cdp","node","service"],"created_at":"2024-11-13T10:32:46.080Z","updated_at":"2025-03-02T06:26:58.236Z","avatar_url":"https://github.com/DEFRA.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aqie-back-end\n\nCore delivery platform Node.js Backend Template.\n\n- [Requirements](#requirements)\n  - [Node.js](#nodejs)\n- [Local development](#local-development)\n  - [Setup](#setup)\n  - [Development](#development)\n  - [Production](#production)\n  - [Npm scripts](#npm-scripts)\n- [API endpoints](#api-endpoints)\n- [Calling API endpoints](#calling-api-endpoints)\n  - [Postman](#postman)\n- [Docker](#docker)\n  - [Development Image](#development-image)\n  - [Production Image](#production-image)\n- [Licence](#licence)\n  - [About the licence](#about-the-licence)\n\n## Requirements\n\n### Node.js\n\nPlease install [Node.js](http://nodejs.org/) `\u003e= v18` and [npm](https://nodejs.org/) `\u003e= v9`. You will find it\neasier to use the Node Version Manager [nvm](https://github.com/creationix/nvm)\n\nTo use the correct version of Node.js for this application, via nvm:\n\n```bash\ncd aqie-back-end\nnvm use\n```\n\n## Local development\n\n### Setup\n\nInstall application dependencies:\n\n```bash\nnpm install\n```\n\n### Development\n\nTo run the application in `development` mode run:\n\n```bash\nnpm run dev\n```\n\n### Production\n\nTo mimic the application running in `production` mode locally run:\n\n```bash\nnpm start\n```\n\n### Npm scripts\n\nAll available Npm scripts can be seen in [package.json](./package.json)\nTo view them in your command line run:\n\n```bash\nnpm run\n```\n\n## API endpoints\n\n| Endpoint                       | Description  |\n| :----------------------------- | :----------- |\n| `GET: /health`                 | Health       |\n| `GET: /v1/entities`            | Entities     |\n| `GET: /v1/entities/\u003centityId\u003e` | Entity by ID |\n\n## Calling API endpoints\n\n### Postman\n\nA [Postman](https://www.postman.com/) collection and environment are available for making calls to the Teams and\nRepositories API. Simply import the collection and environment into Postman.\n\n- [CDP Node Backend Template Postman Collection](postman/aqie-back-end.postman_collection.json)\n- [CDP Node Backend Template Postman Environment](postman/aqie-back-end.postman_environment.json)\n\n## Docker\n\n### Development image\n\nBuild:\n\n```bash\ndocker build --target development --no-cache --tag aqie-back-end:development .\n```\n\nRun:\n\n```bash\ndocker run -e GITHUB_API_TOKEN -p 3008:3008 aqie-back-end:development\n```\n\n### Production image\n\nBuild:\n\n```bash\ndocker build --no-cache --tag aqie-back-end .\n```\n\nRun:\n\n```bash\ndocker run -e GITHUB_API_TOKEN -p 3001:3001 aqie-back-end\n```\n\n## Licence\n\nTHIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:\n\n\u003chttp://www.nationalarchives.gov.uk/doc/open-government-licence/version/3\u003e\n\nThe following attribution statement MUST be cited in your products and applications when using this information.\n\n\u003e Contains public sector information licensed under the Open Government license v3\n\n### About the licence\n\nThe Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable\ninformation providers in the public sector to license the use and re-use of their information under a common open\nlicence.\n\nIt is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefra%2Faqie-back-end","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdefra%2Faqie-back-end","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefra%2Faqie-back-end/lists"}