LennardZuendorf commited on
Commit
c5c1df2
Β·
1 Parent(s): 2492536

fix: updating running info in readme

Browse files
Files changed (2) hide show
  1. Dockerfile +2 -2
  2. README.md +7 -9
Dockerfile CHANGED
@@ -19,5 +19,5 @@ RUN ls --recursive .
19
  CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8080"]
20
 
21
  # build and run commands:
22
- ## docker build -t thesis:0.1.4 -f Dockerfile .
23
- ## docker run -d --name thesis -p 8080:8080 thesis:0.1.4
 
19
  CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8080"]
20
 
21
  # build and run commands:
22
+ ## docker build -t thesis:1.2.1 -f Dockerfile .
23
+ ## docker run -d --name thesis -e HOSTING=local -p 8080:8080 thesis:1.2.1
README.md CHANGED
@@ -44,30 +44,28 @@ This Project was part of my studies of Business Computing at the University of A
44
 
45
  ## Running the Project:
46
 
47
- ### 🐍 Python:
48
-
49
  (This assumes you have set up a python environment, I recommend using a virtual environment.)
50
 
51
  1. Clone the repository using git or GitHub cli.
52
  2. Start the (virtual) environment.
 
53
  3. Install the requirements using `pip install -r requirements.txt`
54
  4. Run the app using `uvicorn main:app`. You can add `--reload` to enable hot reloading. The app will be available at `localhost:8000`.
55
 
56
- ### 🐳 Dockerfile:
57
-
58
  (This assumes you have set up docker desktop or are using a hosting service able to handle Dockerfiles.)
59
 
60
  1. Clone the repository using git or GitHub cli.
61
- 2. Build the docker image using `docker build -t thesis-webapp .`, the command commented in the docker file or the command referenced by your hosting service.
62
- 3. Run the docker image using `docker run -p 8080:8080 thesis-webapp`, the command commented in the docker file or the command referenced by your hosting service.
63
  4. The app will be available at `localhost:8080`. If you are using a hosting service, the port may be different.
64
 
65
- ### 🐳 Docker Image:
66
-
67
  (This assumes you have set up docker desktop or are using a hosting service able to handle Docker images.)
68
 
69
  1. Pull the docker image from ghcr using `docker pull ghcr.io/LennardZuendorf/thesis-webapp:latest`.
70
- 2. Run the docker image using `docker run -p 8080:8080 lennardzuendorf/thesis-webapp:latest`, the command commented in the docker file or the command referenced by your hosting service.
71
  3. The app will be available at `localhost:8080`. If you are using a hosting service, the port may be different.
72
 
73
  ## πŸ“ License and Credits:
 
44
 
45
  ## Running the Project:
46
 
47
+ ### 🐍 Python with [FastAPI](https://fastapi.tiangolo.com/) :
 
48
  (This assumes you have set up a python environment, I recommend using a virtual environment.)
49
 
50
  1. Clone the repository using git or GitHub cli.
51
  2. Start the (virtual) environment.
52
+ 3. Set the environment variable "HOSTING", i.e. like this `export HOSTING="local"`, see [fastAPI Docu](https://fastapi.tiangolo.com/advanced/settings/)
53
  3. Install the requirements using `pip install -r requirements.txt`
54
  4. Run the app using `uvicorn main:app`. You can add `--reload` to enable hot reloading. The app will be available at `localhost:8000`.
55
 
56
+ ### 🐳 Dockerfile :
 
57
  (This assumes you have set up docker desktop or are using a hosting service able to handle Dockerfiles.)
58
 
59
  1. Clone the repository using git or GitHub cli.
60
+ 2. Build the docker image using `docker build -t thesis-webapp -f Dockerfile . .`, the command commented in the docker file or the command referenced by your hosting service.
61
+ 3. Run the docker image using `docker run --name thesis-webapp -e HOSTING=local -p 8080:8080 thesis-webapp`, the command commented in the docker file or the command referenced by your hosting service.
62
  4. The app will be available at `localhost:8080`. If you are using a hosting service, the port may be different.
63
 
64
+ ### 🐳 Docker Image :
 
65
  (This assumes you have set up docker desktop or are using a hosting service able to handle Docker images.)
66
 
67
  1. Pull the docker image from ghcr using `docker pull ghcr.io/LennardZuendorf/thesis-webapp:latest`.
68
+ 2. Run the docker image in terminal using `docker run --name thesis-webapp -e HOSTING=local -p 8080:8080 lennardzuendorf/thesis-webapp:latest`, the command commented in the docker file or the command referenced by your hosting service.
69
  3. The app will be available at `localhost:8080`. If you are using a hosting service, the port may be different.
70
 
71
  ## πŸ“ License and Credits: