https://github.com/ndlano/image-api

DEPRECATED! Moved into the backend monorepo: https://github.com/NDLANO/backend. API for accessing images
https://github.com/ndlano/image-api

api image images ndla

Last synced: about 5 hours ago
JSON representation

DEPRECATED! Moved into the backend monorepo: https://github.com/NDLANO/backend. API for accessing images

• Host: GitHub
• URL: https://github.com/ndlano/image-api
• Owner: NDLANO
• License: gpl-3.0
• Created: 2016-07-27T12:01:46.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-08T13:32:52.000Z (almost 2 years ago)
• Last Synced: 2024-04-13T16:16:11.326Z (7 months ago)
• Topics: api, image, images, ndla
• Language: Scala
• Homepage:
• Size: 5.16 MB
• Stars: 3
• Watchers: 10
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# IMAGE API 

![CI](https://github.com/NDLANO/image-api/workflows/CI/badge.svg)

## Usage

Creates, updates and returns metadata about an image. It also supports resizing and cropping images on the fly.

Implements ElasticSearch for search within the article database.

To interact with the API, you need valid security credentials; see [Access Tokens usage](https://github.com/NDLANO/auth/blob/master/README.md).

To write data to the api, you need write role access.

It also has as internal import routines for importing images from the old system to this database.

For a more detailed documentation of the API, please refer to the [API documentation](https://api.ndla.no) (Staging: [API documentation](https://staging.api.ndla.no)).

## Developer documentation

**Compile:** sbt compile

**Run tests:** sbt test

**Create Docker Image:** sbt docker