https://github.com/defra/phi-repo-backend
Git repository for service phi-repo-backend
https://github.com/defra/phi-repo-backend
backend cdp node service
Last synced: about 1 month ago
JSON representation
Git repository for service phi-repo-backend
- Host: GitHub
- URL: https://github.com/defra/phi-repo-backend
- Owner: DEFRA
- License: other
- Created: 2024-03-26T13:45:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T13:45:27.000Z (over 2 years ago)
- Last Synced: 2025-10-14T04:12:51.923Z (9 months ago)
- Topics: backend, cdp, node, service
- Language: JavaScript
- Size: 108 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# phi-repo-backend
Core delivery platform Node.js Backend Template.
- [Requirements](#requirements)
- [Node.js](#nodejs)
- [Local development](#local-development)
- [Setup](#setup)
- [Development](#development)
- [Production](#production)
- [Npm scripts](#npm-scripts)
- [API endpoints](#api-endpoints)
- [Calling API endpoints](#calling-api-endpoints)
- [Postman](#postman)
- [Docker](#docker)
- [Development Image](#development-image)
- [Production Image](#production-image)
- [Licence](#licence)
- [About the licence](#about-the-licence)
## Requirements
### Node.js
Please install [Node.js](http://nodejs.org/) `>= v18` and [npm](https://nodejs.org/) `>= v9`. You will find it
easier to use the Node Version Manager [nvm](https://github.com/creationix/nvm)
To use the correct version of Node.js for this application, via nvm:
```bash
cd phi-repo-backend
nvm use
```
## Local development
### Setup
Install application dependencies:
```bash
npm install
```
### Development
To run the application in `development` mode run:
```bash
npm run dev
```
### Production
To mimic the application running in `production` mode locally run:
```bash
npm start
```
### Npm scripts
All available Npm scripts can be seen in [package.json](./package.json)
To view them in your command line run:
```bash
npm run
```
## API endpoints
| Endpoint | Description |
| :----------------------------- | :----------- |
| `GET: /health` | Health |
| `GET: /v1/entities` | Entities |
| `GET: /v1/entities/` | Entity by ID |
## Calling API endpoints
### Postman
A [Postman](https://www.postman.com/) collection and environment are available for making calls to the Teams and
Repositories API. Simply import the collection and environment into Postman.
- [CDP Node Backend Template Postman Collection](postman/phi-repo-backend.postman_collection.json)
- [CDP Node Backend Template Postman Environment](postman/phi-repo-backend.postman_environment.json)
## Docker
### Development image
Build:
```bash
docker build --target development --no-cache --tag phi-repo-backend:development .
```
Run:
```bash
docker run -e GITHUB_API_TOKEN -p 3008:3008 phi-repo-backend:development
```
### Production image
Build:
```bash
docker build --no-cache --tag phi-repo-backend .
```
Run:
```bash
docker run -e GITHUB_API_TOKEN -p 3001:3001 phi-repo-backend
```
## Licence
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
The following attribution statement MUST be cited in your products and applications when using this information.
> Contains public sector information licensed under the Open Government license v3
### About the licence
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable
information providers in the public sector to license the use and re-use of their information under a common open
licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.