Merge pull request #27 from jmuzina/build-updates

Change local dev environment setup to use Docker
jmuzina · Jan 13, 2024 · 4869dc9 · 4869dc9
2 parents 4f02115 + 241b2a6
commit 4869dc9
Show file tree

Hide file tree

Showing 51 changed files with 62 additions and 20 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,6 @@
+src/logs
+src/uploads
+start.sh
+start.bat
+venv
+Dockerfile-local
diff --git a/.gitignore b/.gitignore
@@ -2,17 +2,18 @@
 *venv*
 
 # User uploaded files directory
-uploads/
+src/uploads/
 # sensitive auth data
 *.cfg
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
-static/all.css
+src/static/all.css
 
 # logging data
-logs/
+src/logs
+src/uploads
 
 # C extensions
 *.so
@@ -113,7 +114,7 @@ celerybeat.pid
 *.sage.py
 
 # Environments
-.env
+src/.env
 .venv
 env/
 venv/
@@ -139,3 +140,7 @@ dmypy.json
 # Pyre type checker
 .pyre/
 *.cfg
+
+# IDEs
+/.vscode
+/.idea
diff --git a/Dockerfile-local b/Dockerfile-local
@@ -0,0 +1,17 @@
+FROM python:3.9.18-slim-bullseye
+
+# Set the working directory in the container
+WORKDIR /gpxvis
+
+# Copy the dependencies file to the working directory
+COPY src/ /gpxvis/
+
+# Install any dependencies
+RUN pip3 install -r requirements.txt
+RUN rm requirements.txt
+
+# Listen on port 5000
+EXPOSE 5000
+
+# Run flask
+ENTRYPOINT ["python3", "-m", "flask", "run", "--host=0.0.0.0"]
diff --git a/readme.md → README.md b/readme.md → README.md
@@ -7,11 +7,19 @@
 * **Activity filtering**: Filter activities by date, activity type, and other attributes
 * **Generate custom images**: Turn your activities into images with custom color, background, and style!
 ------------------
-## Building
-- Install python dependencies: `pip install -r requirements.txt`
-- Set environment variables (.env):
-  - `APP_ADDRESS`: Base address of the application where it is being served. If unset, the app will use `http://127.0.0.1:5000`.
+## Running in developer environment
+- Set environment variables (src/.env):
+  - `APP_ADDRESS`: Base address of the application where it is being served. If unset, the app will use [http://localhost](http://localhost).
   - Strava auth data (see [Developer Dashboard](https://www.strava.com/settings/api))
     - `STRAVA_CLIENT_ID`: Strava OAUTH Client ID
     - `STRAVA_CLIENT_SECRET`: Strava OAUTH Client Secret
-- Run Flask locally: `python3 -m flask run`
+
+### Docker container
+
+Docker is used to build and run the application.
+
+#### Windows
+`./start.bat`
+
+#### Unix
+`source ./start.sh`
diff --git a/SessionTimer.py → src/SessionTimer.py b/SessionTimer.py → src/SessionTimer.py
diff --git a/app.py → src/app.py b/app.py → src/app.py
@@ -286,38 +286,38 @@ def refreshSessionTimer():
 
 @flaskApp.route("/activityFiltering.js")
 def returnActivityFiltering():
-    return send_file("./static/activityFiltering.js")
+    return send_file("static/activityFiltering.js")
 
 @flaskApp.route("/fileVerification.js")
 def returnFileVerification():
-    return send_file("./static/fileVerification.js")
+    return send_file("static/fileVerification.js")
 
 @flaskApp.route("/dynamicParameters.js")
 def returnDynamicParameters():
-    return send_file("./static/dynamicParameters.js")
+    return send_file("static/dynamicParameters.js")
 
 @flaskApp.route("/resize.js")
 def returnResize():
-    return send_file("./static/resize.js")
+    return send_file("static/resize.js")
 
 @flaskApp.route("/logo")
 def returnLogo():
     if not request.args.get("size") or request.args.get("size") == "full":
-        return send_file("./static/logo/logo_full.png")
+        return send_file("static/logo/logo_full.png")
     elif request.args.get("size") == "300":
-        return send_file("./static/logo/logo_300.png")
+        return send_file("static/logo/logo_300.png")
     elif request.args.get("size") == "favicon":
-        return send_file("./static/logo/favicons/favicon.ico")
+        return send_file("static/logo/favicons/favicon.ico")
     else:
         return functions.throwError("Invalid logo size argument given.")
 
 @flaskApp.route("/favicon.ico")
 def returnFavicon():
-    return send_file("./static/logo/favicons/favicon.ico")
+    return send_file("static/logo/favicons/favicon.ico")
 
 @flaskApp.route("/wait.js")
 def returnWait():
-    return send_file("./static/wait.js")
+    return send_file("static/wait.js")
 
 @flaskApp.route('/aboutPage')
 def render_aboutPage():

diff --git a/functions.py → src/functions.py b/functions.py → src/functions.py
diff --git a/generateVis.py → src/generateVis.py b/generateVis.py → src/generateVis.py
@@ -152,7 +152,7 @@ def draw_overlay(self):
 
         ##draw text background fade
         if(self.textBackgroundFade == True):
-            fade = pil_image.open("static/fade.png").resize((self.resolution,self.resolution))
+            fade = pil_image.open("static/fade.png").resize((self.resolution, self.resolution))
             self.image = pil_image.alpha_composite(self.image, fade)
         ##draw grid
         if (self.gridOn==True): 

diff --git a/networks/strava.py → src/networks/strava.py b/networks/strava.py → src/networks/strava.py
@@ -16,7 +16,7 @@ def __init__(self, app):
         self.tokenUrl = 'https://www.strava.com/oauth/token'.strip('\'')
         self.clientId = os.getenv('STRAVA_CLIENT_ID').strip('\'')
         self.clientSecret = os.getenv('STRAVA_CLIENT_SECRET').strip('\'')
-        self.authUrl = "www.strava.com/oauth/authorize?client_id={client_id}&response_type=code&redirect_uri={app_address}/strava-login&approval_prompt=auto&scope=read,activity:read".format(client_id=os.getenv('STRAVA_CLIENT_ID'), app_address=os.getenv('APP_ADDRESS') or 'http://127.0.0.1:5000').strip('\'')
+        self.authUrl = "www.strava.com/oauth/authorize?client_id={client_id}&response_type=code&redirect_uri={app_address}/strava-login&approval_prompt=auto&scope=read,activity:read".format(client_id=os.getenv('STRAVA_CLIENT_ID'), app_address=os.getenv('APP_ADDRESS') or 'http://localhost').strip('\'')
         self.verifyToken = str(binascii.hexlify(os.urandom(24)))[2:-1]
         self.loginWith = True
 

diff --git a/networks/twitter.py → src/networks/twitter.py b/networks/twitter.py → src/networks/twitter.py
diff --git a/requirements.txt → src/requirements.txt b/requirements.txt → src/requirements.txt
diff --git a/static/activityFiltering.js → src/static/activityFiltering.js b/static/activityFiltering.js → src/static/activityFiltering.js
diff --git a/static/aileron/Aileron-Regular.otf → src/static/aileron/Aileron-Regular.otf b/static/aileron/Aileron-Regular.otf → src/static/aileron/Aileron-Regular.otf
diff --git a/static/dynamicParameters.js → src/static/dynamicParameters.js b/static/dynamicParameters.js → src/static/dynamicParameters.js
diff --git a/static/fade.png → src/static/fade.png b/static/fade.png → src/static/fade.png
diff --git a/static/fileVerification.js → src/static/fileVerification.js b/static/fileVerification.js → src/static/fileVerification.js
diff --git a/static/gpx_banner.png → src/static/gpx_banner.png b/static/gpx_banner.png → src/static/gpx_banner.png
diff --git a/.../logo/favicons/android-chrome-192x192.png → .../logo/favicons/android-chrome-192x192.png b/.../logo/favicons/android-chrome-192x192.png → .../logo/favicons/android-chrome-192x192.png
diff --git a/.../logo/favicons/android-chrome-512x512.png → .../logo/favicons/android-chrome-512x512.png b/.../logo/favicons/android-chrome-512x512.png → .../logo/favicons/android-chrome-512x512.png
diff --git a/static/logo/favicons/apple-touch-icon.png → ...static/logo/favicons/apple-touch-icon.png b/static/logo/favicons/apple-touch-icon.png → ...static/logo/favicons/apple-touch-icon.png
diff --git a/static/logo/favicons/favicon-16x16.png → src/static/logo/favicons/favicon-16x16.png b/static/logo/favicons/favicon-16x16.png → src/static/logo/favicons/favicon-16x16.png
diff --git a/static/logo/favicons/favicon-32x32.png → src/static/logo/favicons/favicon-32x32.png b/static/logo/favicons/favicon-32x32.png → src/static/logo/favicons/favicon-32x32.png
diff --git a/static/logo/favicons/favicon.ico → src/static/logo/favicons/favicon.ico b/static/logo/favicons/favicon.ico → src/static/logo/favicons/favicon.ico
diff --git a/static/logo/logo_300.png → src/static/logo/logo_300.png b/static/logo/logo_300.png → src/static/logo/logo_300.png
diff --git a/static/logo/logo_full.png → src/static/logo/logo_full.png b/static/logo/logo_full.png → src/static/logo/logo_full.png
diff --git a/static/profile-images/adam.png → src/static/profile-images/adam.png b/static/profile-images/adam.png → src/static/profile-images/adam.png
diff --git a/static/profile-images/anthony.jpg → src/static/profile-images/anthony.jpg b/static/profile-images/anthony.jpg → src/static/profile-images/anthony.jpg
diff --git a/static/profile-images/james.jpg → src/static/profile-images/james.jpg b/static/profile-images/james.jpg → src/static/profile-images/james.jpg
diff --git a/static/profile-images/parker.jpg → src/static/profile-images/parker.jpg b/static/profile-images/parker.jpg → src/static/profile-images/parker.jpg
diff --git a/static/resize.js → src/static/resize.js b/static/resize.js → src/static/resize.js
diff --git a/static/silhouette-images/fortniteDance.gif → ...tatic/silhouette-images/fortniteDance.gif b/static/silhouette-images/fortniteDance.gif → ...tatic/silhouette-images/fortniteDance.gif
diff --git a/static/silhouette-images/sil2021.png → src/static/silhouette-images/sil2021.png b/static/silhouette-images/sil2021.png → src/static/silhouette-images/sil2021.png
diff --git a/static/silhouette-images/sil2022.png → src/static/silhouette-images/sil2022.png b/static/silhouette-images/sil2022.png → src/static/silhouette-images/sil2022.png
diff --git a/static/silhouette-images/silBicycle.png → src/static/silhouette-images/silBicycle.png b/static/silhouette-images/silBicycle.png → src/static/silhouette-images/silBicycle.png
diff --git a/static/silhouette-images/silBicyclesmall.png → ...tic/silhouette-images/silBicyclesmall.png b/static/silhouette-images/silBicyclesmall.png → ...tic/silhouette-images/silBicyclesmall.png
diff --git a/static/silhouette-images/silRunner.png → src/static/silhouette-images/silRunner.png b/static/silhouette-images/silRunner.png → src/static/silhouette-images/silRunner.png
diff --git a/static/silhouette-images/silRunnerSmall.png → ...atic/silhouette-images/silRunnerSmall.png b/static/silhouette-images/silRunnerSmall.png → ...atic/silhouette-images/silRunnerSmall.png
diff --git a/static/silhouette-images/silStar.png → src/static/silhouette-images/silStar.png b/static/silhouette-images/silStar.png → src/static/silhouette-images/silStar.png
diff --git a/static/silhouette-images/silStrava.png → src/static/silhouette-images/silStrava.png b/static/silhouette-images/silStrava.png → src/static/silhouette-images/silStrava.png
diff --git a/static/style.scss → src/static/style.scss b/static/style.scss → src/static/style.scss
diff --git a/static/wait.js → src/static/wait.js b/static/wait.js → src/static/wait.js
diff --git a/templates/aboutPage.html → src/templates/aboutPage.html b/templates/aboutPage.html → src/templates/aboutPage.html
diff --git a/templates/errorPage.html → src/templates/errorPage.html b/templates/errorPage.html → src/templates/errorPage.html
diff --git a/templates/generatePage.html → src/templates/generatePage.html b/templates/generatePage.html → src/templates/generatePage.html
diff --git a/templates/index.html → src/templates/index.html b/templates/index.html → src/templates/index.html
diff --git a/templates/navBar.html → src/templates/navBar.html b/templates/navBar.html → src/templates/navBar.html
diff --git a/templates/parameters.html → src/templates/parameters.html b/templates/parameters.html → src/templates/parameters.html
diff --git a/templates/privacyPage.html → src/templates/privacyPage.html b/templates/privacyPage.html → src/templates/privacyPage.html
diff --git a/wsgi.py → src/wsgi.py b/wsgi.py → src/wsgi.py
diff --git a/start.bat b/start.bat
@@ -0,0 +1,2 @@
+Docker build -f ./Dockerfile-local . -t gpxvis:latest
+Docker run -d -p 80:5000 --name gpxivs gpxvis:latest
diff --git a/start.sh b/start.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+
+Docker build -f ./Dockerfile-local . -t gpxvis:latest
+Docker run -d -p 80:5000 --name gpxivs gpxvis:latest
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Docker build -f ./Dockerfile-local . -t gpxvis:latest
		Docker run -d -p 80:5000 --name gpxivs gpxvis:latest