Skip to content

Knox-AAU/Metadata-api

Repository files navigation

Meta data API

Installation

  1. Ensure you have docker and docker-compose
  2. Optionally setup a virtual environment
  3. If running in production mode:
docker-compose -f prod-docker-compose.yml up
  1. If running in development mode:
docker-compose -f dev-docker-compose.yml up
  1. Access the api at the specified host and port (if not changed: http://localhost:5000/)

Documentation

Use Postman and import the documentation from the file "P5-Metadata-api.postman_collection.json"

To make changes

  1. Clone the repository from here
  2. Make the changes you want to make
  3. Update the api documentation
  4. Push them into a branch
  5. Make a pull request
  6. Ensure pipelines pass

To use linter

pylint ./**/*.py

TODO

See: https://github.com/orgs/Knox-AAU/projects/26/

Releases

No releases published

Packages

No packages published

Languages