added readme

This commit is contained in:
heyethereum
2024-08-13 02:21:02 +08:00
parent 76054d6373
commit 762c43ac24
2 changed files with 15 additions and 1 deletions

2
.gitignore vendored
View File

@@ -4,7 +4,7 @@ __pycache__/
*$py.class *$py.class
# C extensions # C extensions
*.so .DS_Store
# Distribution / packaging # Distribution / packaging
.Python .Python

14
REAME.md Normal file
View File

@@ -0,0 +1,14 @@
# SafeQR FastAPI Application
This repository contains the SafeQR FastAPI application, which is packaged as a Docker image. This document provides instructions on how to build, run, and stop the Docker container for this application.
## Prerequisites
- **Docker**: Ensure Docker is installed on your system. You can download it from [Docker's official website](https://www.docker.com/get-started).
## Build the Docker Image
If you haven't built the Docker image yet, you can do so with the following command:
```bash
docker build -t safeqr-fastapi-app .