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

DEPRECATED! Moved into the backend monorepo: https://github.com/NDLANO/backend. API for Learningpaths from NDLA
https://github.com/ndlano/learningpath-api

learningpath-api scala

Last synced: about 2 months ago
JSON representation

DEPRECATED! Moved into the backend monorepo: https://github.com/NDLANO/backend. API for Learningpaths from NDLA

• Host: GitHub
• URL: https://github.com/ndlano/learningpath-api
• Owner: NDLANO
• License: gpl-3.0
• Created: 2016-08-11T12:52:54.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-11-08T13:33:51.000Z (about 2 years ago)
• Last Synced: 2024-04-14T17:20:17.860Z (9 months ago)
• Topics: learningpath-api, scala
• Language: Scala
• Homepage:
• Size: 1.5 MB
• Stars: 2
• Watchers: 12
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Learningpath API

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

## Usage

Creates, updates, deletes and returns a Learningpath. Implements Elasticsearch for search within the learningpath database.

#### Licenses

Returns a list of licenses with the possibility of filtering on the license key.

#### Api access

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. This is only accessible in [learningpath-frontend](https://learningpath-frontend.staging.api.ndla.no) today.

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

**Run integration tests:** sbt it:test

**Create Docker Image:** ./build.sh

## Create Docker Image

    ./build.sh