https://github.com/openconext/stepup-api

Application Programming Interface for OpenConext-Stepup
https://github.com/openconext/stepup-api

Last synced: about 1 year ago
JSON representation

Application Programming Interface for OpenConext-Stepup

• Host: GitHub
• URL: https://github.com/openconext/stepup-api
• Owner: OpenConext
• License: apache-2.0
• Created: 2023-06-07T13:12:07.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-06T14:20:07.000Z (almost 3 years ago)
• Last Synced: 2025-01-03T03:35:09.627Z (over 1 year ago)
• Language: PHP
• Size: 81.1 KB
• Stars: 2
• Watchers: 9
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Step-up API

==================

[![Build Status](https://travis-ci.org/OpenConext/Stepup-API.svg)](https://travis-ci.org/OpenConext/Stepup-API) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/OpenConext/Stepup-API/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/OpenConext/Stepup-API/?branch=develop)

This component is part of "Step-up Middleware". See [Stepup-Deploy](https://github.com/OpenConext/Stepup-Deploy) for an overview and installation instructions for a complete Stepup system, including this component. The requirements and installation instructions below cover this component only.

## Warning :warning:

This project is currently a work in progress and is being used as a proof of concept. This means that it might not (fully) work yet.

## Requirements

* PHP 8.1+

* [Composer](https://getcomposer.org/)

* A web server (Apache, Nginx)

* A working [Middleware](https://github.com/OpenConext/Stepup-Middleware)

* Docker

* Docker Compose

## For developers

To create a development environment for this project, the following commands need to be executed:

```bash

$ docker compose up -d

$ docker compose exec stepup-api -c 'composer install'

```