Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.17 KB

readme.md

File metadata and controls

29 lines (19 loc) · 1.17 KB

FastAPI Project with Docker Integration

Project Overview

This project aims to enhance privacy mechanisms in web applications by creating a FastAPI-based backend served through a Docker container. The API provides endpoints for user consent management, detailing purpose specification and metadata about the data collected. This project aligns with the principles outlined in the research on Hippocratic APIs.

Features

  • Privacy-Aware Consent Mechanisms: Dynamic consent forms generated via FastAPI.
  • Docker Integration: Easy deployment and environment consistency using Docker.
  • Secure API Endpoints: API key-based authentication for accessing protected endpoints.
  • Automatic OpenAPI Documentation: Interactive API documentation generated by FastAPI.

Getting Started

Prerequisites

  • Docker: Ensure Docker is installed on your system. You can download it from here.
  • Git: Ensure Git is installed to clone the repository.

Setup

  1. Clone the Repository

    git clone [email protected]:sadmad/Hapi.git
cd Hapi
docker build -t hapi
docker run -d -p 8000:8000 --name hapi-container hapi