Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.2 KB

software-requirements.md

File metadata and controls

42 lines (24 loc) · 2.2 KB

NDE Software Requirements

Introduction

This document specifies minimal technical requirements for software services to be able to run in the NDE infrastructure. These requirements apply to web applications as well as APIs and background services. The requirements are an application of the CLARIAH Software and Service Requirements to the NDE context.

Requirements

1. The software’s source code MUST be stored in a public version control system.

This defaults to NDE’s GitHub organization.

See CLARIAH #1

2. A README file MUST be provided in the root directory.

See CLARIAH #2.

3. The software MUST have a public issue tracker.

This defaults to the repository’s issue tracker on GitHub.

See CLARIAH #7.

4. The software MUST be packaged as a container.

The software service MUST be packaged as an OCI container (e.g. Docker containers) for portability.

See CLARIAH #15.

5. The software MUST be configurable through environment variables.

Examples of configuration parameters are credentials, API tokens and database connection information. These parameters MUST NOT be part of the application’s source code. Instead, the application MUST read configuration from environment variables, the values for which can be provided by the infrastructure.

See CLARIAH #5.