Function Repository API

Part of the EDGELESS Project

Overview

The Function Repository API is a component of EDGELESS, designed to store and manage both functions and workflows. This API allows for handling of multiple versions of functions, including their creation, update, deletion, and retrieval. It also provides tools for defining and managing workflows that utilize these functions.

Features

• Function Management:

  • Create, update, delete, and retrieve functions.
  • Manage multiple versions of a function.
  • Upload and download function code files.
  • Retrieve function versions.

• Workflow Management:

  • Create, update, delete, and retrieve workflows.
  • Define workflows using JSON, referencing existing functions in the repository.

Usage

This API is intended for:

• Function Developers (funcdev): To manage functions.
• Application Developers (appdev): To manage workflows.

Technology Stack

• TypeScript
• Nest.js
• MongoDB

Development

Prerequisites

• MongoDB

MongoDB Installation (with Docker Container)

1. Download MongoDB Image

docker pull mongo:4

2. Run MongoDB Container

docker run --name mongo-nest -p 27017:27017 -d mongo:4

Installation

1. Go to project folder and install dependencies:

npm install

2. Launch development server, and open localhost:3003 in your browser:

npm start

Main tasks

Task automation is based on NPM scripts.

Task	Description
npm start	Run development server on http://localhost:3003/

---

NPM scripts

• npm start - Start application
• npm run build - Build application

Deployment

This API can be deployed using Docker. A Dockerfile is provided to build and run the API in a containerized environment.

Docker Deployment

To deploy the API using Docker, follow these steps:

1. Build the Docker image:

   docker build -t function-repository-api .

2. Run the Docker container:

   docker run -p 3000:3000 function-repository-api

License

The Repository is licensed under the MIT License.

Funding

EDGELESS received funding from the European Health and Digital Executive Agency (HADEA) program under Grant Agreement No 101092950.