From 762c43ac24744ee810fba653d4b14730d72675ec Mon Sep 17 00:00:00 2001 From: heyethereum Date: Tue, 13 Aug 2024 02:21:02 +0800 Subject: [PATCH] added readme --- .gitignore | 2 +- REAME.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 REAME.md diff --git a/.gitignore b/.gitignore index efa407c..0036c96 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,7 @@ __pycache__/ *$py.class # C extensions -*.so +.DS_Store # Distribution / packaging .Python diff --git a/REAME.md b/REAME.md new file mode 100644 index 0000000..00c1d6a --- /dev/null +++ b/REAME.md @@ -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 .