From 8b459eb16ec559fefadfe4711472678bfbb1789a Mon Sep 17 00:00:00 2001 From: Mary Mbaoma Date: Wed, 19 Jul 2023 17:43:14 +0100 Subject: [PATCH] change filename (#2) * feat: production ready qr-code-generator - initial version --- .github/{.workflows => workflows}/main.yml | 0 Dockerfile | 2 +- README.md | 18 ++++++------------ 3 files changed, 7 insertions(+), 13 deletions(-) rename .github/{.workflows => workflows}/main.yml (100%) diff --git a/.github/.workflows/main.yml b/.github/workflows/main.yml similarity index 100% rename from .github/.workflows/main.yml rename to .github/workflows/main.yml diff --git a/Dockerfile b/Dockerfile index 18df577..5e7f7d2 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,7 +8,7 @@ COPY . . # RUN pip install --no-cache-dir fastapi uvicorn[standard] gunicorn qrcode[pil] RUN pip install --no-cache-dir -r requirements.txt -# Make port 80 available to the world outside this container +# Make port 8000 available to the world outside this container EXPOSE 8000 # Run the command to start uvicorn diff --git a/README.md b/README.md index a084a4e..e517251 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,6 @@ A FastAPI endpoint that creates QR codes based off given URLs -## Setting up .env file - -- Clone the [repo](https://github.com/development-captains/test-80-np.pluto.onglueops.rocks) into a codespace. - -- Then run, in the root folder -```bash -$ source .env -``` - -- Clone the repository you want to work on and ```cd``` into that directory. - ## Running the QR code generator - Development environment @@ -32,7 +21,12 @@ $ docker run -p 8000:8000 qr-bot-generator ## Access the website -- In your browser, navigate to ```https://127.0.0.1:8000.preview.app.github.dev/v1/qr?url=``` +- In your browser, navigate to ```https://127.0.0.1:8000.preview.app.github.dev/v1/qr?url=``` - localhost, ```https://qr-code-generator./v1/qr?url=``` - Kubernetes deployment A QR code will be generated image + +## Deploying on ArgoCD +- Reference [this](https://github.com/GlueOps/project-template-helm-chart-app) repo for parameters to include in your ArgoCD manifest. + +- Video guide [1](https://drive.google.com/file/d/1gBThTF1ln-UTrxrMmle6K_0YEXunxBjz/view) & [2](https://drive.google.com/file/d/1gBThTF1ln-UTrxrMmle6K_0YEXunxBjz/view)