https://github.com/defra/ai-techspike-vision
Git repository for service ai-techspike-vision
https://github.com/defra/ai-techspike-vision
backend cdp node service
Last synced: over 1 year ago
JSON representation
Git repository for service ai-techspike-vision
- Host: GitHub
- URL: https://github.com/defra/ai-techspike-vision
- Owner: DEFRA
- License: other
- Created: 2024-07-11T12:17:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-11T14:02:38.000Z (almost 2 years ago)
- Last Synced: 2025-01-12T19:10:31.523Z (over 1 year ago)
- Topics: backend, cdp, node, service
- Language: JavaScript
- Size: 240 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ai-techspike-vision
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)
- [Formatting](#formatting)
- [Windows prettier issue](#windows-prettier-issue)
- [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 ai-techspike-vision
nvm use
```
## Local development
### Setup
Install application dependencies:
```bash
npm install
```
### Development
To run the application in `development` mode run:
```bash
npm run dev
```
### Testing
To test the application run:
```bash
npm run test
```
### 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
```
### Formatting
#### Windows prettier issue
If you are having issues with formatting of line breaks on Windows update your global git config by running:
```bash
git config --global core.autocrlf false
```
## API endpoints
| Endpoint | Description |
| :------------------- | :----------------------------- |
| `GET: /health` | Health |
| `GET: /example ` | Example API (remove as needed) |
| `GET: /example/` | Example API (remove as needed) |
## Calling API endpoints
### Postman
A [Postman](https://www.postman.com/) collection and environment are available for making calls to the ai-techspike-vision API.
Simply import the collection and environment into Postman.
- [CDP Node Backend Template Postman Collection](postman/ai-techspike-vision.postman_collection.json)
- [CDP Node Backend Template Postman Environment](postman/ai-techspike-vision.postman_environment.json)
## Development helpers
### MongoDB Locks
If you require a write lock for Mongo you can acquire it via `server.locker` or `request.locker`:
```javascript
async function doStuff(server) {
const lock = await server.locker.lock('unique-resource-name')
if (!lock) {
// Lock unavailable
return
}
try {
// do stuff
} finally {
await lock.free()
}
}
```
Keep it small and atomic.
You may use **using** for the lock resource management.
Note test coverage reports do not like that syntax.
```javascript
async function doStuff(server) {
await using lock = await server.locker.lock('unique-resource-name')
if (!lock) {
// Lock unavailable
return
}
// do stuff
// lock automatically released
}
```
Helper methods are also available in `/src/helpers/mongo-lock.js`.
## Docker
### Development image
Build:
```bash
docker build --target development --no-cache --tag ai-techspike-vision:development .
```
Run:
```bash
docker run -e PORT=3001 -p 3001:3001 ai-techspike-vision:development
```
### Production image
Build:
```bash
docker build --no-cache --tag ai-techspike-vision .
```
Run:
```bash
docker run -e PORT=3001 -p 3001:3001 ai-techspike-vision
```
### Docker Compose
A local environment with:
- Localstack for AWS services (S3, SQS)
- Redis
- MongoDB
- This service.
- A commented out frontend example.
```bash
docker compose up --build -d
```
## 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.