Merge pull request #14 from uw935/fix/reqs

v1.3-hotfix: Requirements

.github/workflows/ci.yml

@@ -1,23 +1,43 @@
-name: deployment on server
+name: Create and publish a Docker image
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
 
 jobs:
-  build:
+  build-and-push-image:
     runs-on: ubuntu-latest
 
-    steps:
+    permissions:
-      - uses: actions/checkout@v3
+      contents: read
+      packages: write
 
-      - name: update bot
+    steps:
-        uses: appleboy/ssh-action@v1.0.3
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
         with:
-          host: ${{ secrets.SERVER_HOST }}
+          registry: ${{ env.REGISTRY }}
-          username: ${{ secrets.SERVER_USER }}
+          username: ${{ github.actor }}
-          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          password: ${{ secrets.GITHUB_TOKEN }}
-          port: 22
+
-          script: |
+      - name: Extract metadata (tags, labels) for Docker
-            cd /home/deploy/vatsimfox && git pull origin master --force && cd /home/deploy/vatsimfox/src
+        id: meta
-            docker compose up -d --build
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: src/.
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -1,7 +1,7 @@
 <br>
 <p align="center">
     <img align="center" src="media/cover.png">
-    <h3 align="center">VATSIM Fox</h3>
+    <h3 align="center">VATSIM Fox — v1.2</h3>
     <p align="center">Website to find out your detailed VATSIM stastic</p>
 </p>
 <br>
@@ -14,7 +14,7 @@ Project based on [Virtual Air Traffic Simulation Network (VATSIM) API](https://v
 Written in Python 3.8.18 + JS (JQuery framework) + Boostrap
 
 ## Startup
-For run application on your own machine, you must install docker. Then just one command in the "src" folder with the project source code:
+To run application on your own machine, you must install docker. Then just one command in the "src" folder with the project source code:
 
 ```bash
 docker compose up
@@ -37,6 +37,8 @@ python -m venv venv
 # downloading requirements && upgrading pip
 python -m pip install --upgrade pip
 python -m pip install -r requirements.txt
+# starting application
+python -m flask run --host 0.0.0.0 --debug
 ```
 
 ## Feature

src/Dockerfile

@@ -9,4 +9,4 @@ RUN pip install -r requirements.txt
 
 COPY . /build/
 
-CMD ["python3", "-m", "flask", "run", "--host=0.0.0.0"]
+CMD ["python3", "app.py"]

src/app.py

@@ -1,38 +1,116 @@
+import uvicorn
 import requests
-from flask import Flask, render_template, abort, request, jsonify
+
+from fastapi import (
+    FastAPI,
+    Request,
+    HTTPException,
+)
+from fastapi.responses import FileResponse
+from starlette.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
 
 
-app = Flask(__name__)
 VATSIM_API_URL = "https://api.vatsim.net/v2/"
 
-
+app = FastAPI(
-@app.route("/")
+    title="VATSIM Fox",
-def index_page():
+    docs_url=None,
-    return render_template("index.html")
+    redoc_url=None,
+    openapi_url=None,
+    redirect_slashes=True
+)
+templates = Jinja2Templates(directory="templates")
+app.mount("/static", StaticFiles(directory="static"), name="static")
 
 
-@app.errorhandler(404)
+@app.get("/")
-def errorhandler_page(_):
+async def get_index_page(request: Request):
-    return render_template("4O4.html"), 404
+    """
+    Index page
+
+    :param request: FastAPI request
+    :return: HTML template
+    """
+
+    return templates.TemplateResponse(
+        name="index.html",
+        context={
+            "request": request,
+        }
+    )
 
 
-@app.route("/api/request")
+@app.get("/favicon.ico", include_in_schema=False)
-def request_handler():
+async def get_favicon():
-    if request_string := request.args.get("request_string"):
+    """
-        return requests.get(f"{VATSIM_API_URL}{request_string}").json()
+    Get favicon
 
-    return jsonify({"result": "not found"})
+    :return: Icon file
+    """
+
+    return FileResponse("./static/icon.ico")
 
 
-@app.route("/<int:cid>/")
+@app.get("/{cid}/")
-def viewer_page(cid):
+async def get_viewer_page(request: Request, cid: str = None):
+    """
+    Viewer page
+
+    :param request: FastAPI request
+    :param cid: User CID
+    :return: HTML template
+    """
+    try:
         user = requests.get(f"{VATSIM_API_URL}members/{cid}").json()
+    except requests.exceptions.JSONDecodeError:
+        raise HTTPException(404)
 
     if "detail" in user and user["detail"] == "Not Found":
-        return abort(404)
+        raise HTTPException(404)
 
-    return render_template("viewer.html", data=(user, ))
+    return templates.TemplateResponse(
+        name="viewer.html",
+        context={
+            "user": user,
+            "request": request,
+        }
+    )
+
+
+@app.exception_handler(404)
+async def error_handler(request: Request, _):
+    """
+    Handler to the 404 HTTP error
+
+    :param request: FastAPI request
+    :return: HTML template
+    """
+
+    return templates.TemplateResponse(
+        name="4O4.html",
+        context={
+            "request": request,
+        }
+    )
+
+
+@app.get("/api/request")
+def request_handler(request_string: str):
+    """
+    Wrapper to the VATSIM API functions
+
+    :param request_string: String that will fetched from VATSIM API
+    """
+
+    if request_string:
+        try:
+            return requests.get(f"{VATSIM_API_URL}{request_string}").json()
+        except requests.exceptions.JSONDecodeError:
+            return {"result": "error", "message": "Something went wrong. Report that error please"}
+
+    return {"result": "not found", "message": "Not found"}
 
 
 if __name__ == "__main__":
-    app.run(host="0.0.0.0", port=80)
+    uvicorn.run(app=app, host="0.0.0.0", port=80)

src/requirements.txt

@@ -1,3 +1,5 @@
-Flask==2.2.5
+fastapi==0.110.2
 requests==2.31.0
+uvicorn==0.29.0
 flake8==5.0.4
+Jinja2==3.1.3

src/static/viewer.css

@@ -6,3 +6,7 @@
 .fox_active, .fox_atc_active {
     background-color: #dee2e6 !important;
 }
+
+#notification_wrapper {
+    display: none;
+}

src/static/viewer.js

@@ -2,8 +2,10 @@
 let userSession = {};
 
 fetch(ATC_API_URL, {}).then(response => response.json()).then(result => {
-    if (result && result["result"] == "not found")
+    if (result && (result["result"] == "not found" || result["result"] == "error")) {
-        return
+        showAlert("Error while getting ATC information", result["message"]);
+        return;
+    }
 
     for (let session of result["items"]) {
         // Separate each session by it's connection ID
@@ -72,13 +74,13 @@ $.getJSON("/static/data/airports.json", function(json) {
 
 // Map creation
 const MAP_ELEMENT = L.map("fox_map");
-const MAP_DEFAULT_TARGET = L.latLng("47.50737", "19.04611");
+const MAP_DEFAULT_ZOOM_VIEW = 2;
-const MAP_DEFAULT_ZOOM_VIEW = 14;
+const MAP_DEFAULT_TARGET = L.latLng("0", "0");
 let line = null;
 
 MAP_ELEMENT.setView(MAP_DEFAULT_TARGET, MAP_DEFAULT_ZOOM_VIEW);
 
-L.tileLayer("http://{s}.tile.osm.org/{z}/{x}/{y}.png", {
+L.tileLayer("https://cartodb-basemaps-{s}.global.ssl.fastly.net/light_all/{z}/{x}/{y}.png", {
     attribution: '&copy; <a href="http://osm.org/copyright">OpenStreetMap</a> contributors',
     subdomains: "abcd",
     maxZoom: 20,
@@ -153,3 +155,9 @@ function showSession(session) {
     $(".atc_transfers").text(session["handoffsinitiated"]);
     $(".atc_received").text(session["handoffsreceived"]);
 }
+
+function showAlert(title, message) {
+    $("#notification_wrapper").css("display", "block");
+    $("#notification_title").text(title);
+    $("#notification_message").text(message);
+}

src/templates/include/template.html

@@ -10,33 +10,49 @@
     <meta content="yes" name="apple-touch-fullscreen" />
     <meta name="apple-mobile-web-app-status-bar-style" content="#FA8232">
     <meta name="format-detection" content="telephone=no">
-    <meta name="viewport" content="width = 320, initial-scale = 2.3, user-scalable = no">
+    <link rel="icon" href="{{ url_for('static', path='icon.ico') }}" type="image/x-icon">
-    <link rel="icon" href="{{ url_for('static', filename='icon.ico') }}" type="image/x-icon">
     <title>{% block title %}{% endblock %}</title>
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
     <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65" crossorigin="anonymous">
     {% block header_css %}{% endblock %}
 </head>
 <style>
+    .btn-outline-primary:hover, .btn-outline-primary:active {
+        color: white !important;
+        background-color: var(--main-rgb) !important;
+        border-color: var(--main-rgb) !important;
+    }
+
+    .btn-outline-primary {
+        border-color: var(--main-rgb);
+        color: var(--main-rgb);
+    }
+
 	:root {
+        --main-rgb: #FA8232;
 		--bs-primary-rgb: 250, 130, 50
 	}
 </style>
 <body>
     <main>
+        <header class="border-bottom">
             <div class="container py-4">
-            <header class="pb-3 mb-4 border-bottom">
                 <a href="/" class="d-flex align-items-center text-dark text-decoration-none">
                     <span class="fs-4">🦊 VATSIM <span class="text-primary">Fox</span></span>
                 </a>
+            </div>
         </header>
 
+        <div class="container py-4">
            {% block content %}{% endblock %}
-      
-          <footer class="pt-3 mt-4 text-muted border-top">
-            created by <a href="https://uw935.t.me/" style="text-decoration: underline; cursor: pointer;">uw935</a> (1606255)
-          </footer>
         </div>
+
+        <footer class="text-muted border-top">
+            <div class="container py-4">
+                created by 
+                <a href="https://uw935.com/" style="text-decoration: underline; cursor: pointer;">uw935</a> (1606255)
+            </div>
+        </footer>
 	</main>
 
 	<script src="https://code.jquery.com/jquery-3.7.1.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>

src/templates/index.html

@@ -7,7 +7,7 @@
 		<p class="col-md-8 fs-4">See your detailed profile statistic</p>
 		<div class="d-flex" role="search">
 			<input class="fox_input form-control me-2" type="number" placeholder="100000" aria-label="CID">
-        <button class="fox_submit btn btn-outline-success" type="submit">Search</button>
+			<button class="fox_submit btn btn-outline-primary" type="submit">Search</button>
 		</div>
 		<p class="fox_message text-primary col-md-8 fs-4"></p>
 	</div>
@@ -20,10 +20,12 @@
     		<p>VATSIM Fox is an open-source project to make it easier for users to see their detailed profile statistic</p>
     	</div>
   	</div>
+
 	<div class="col-md-6">
 		<div class="h-100 p-5 bg-light border rounded-3">
 			<h2>Open source project</h2>
 			<p>This project is fully opened, so you can contribute in it if you want</p>
+			
 			<a href="https://github.com/uw935/vatsimfox">
 				<button class="btn btn-outline-secondary" type="button">GitHub</button>
 			</a>

src/templates/viewer.html

@@ -1,12 +1,19 @@
 {% extends "/include/template.html" %}
-{% block title %}User {{user_cid}} statistic — VATSIM Fox{% endblock %}
+{% block title %}User {{user["id"]}} statistic — VATSIM Fox{% endblock %}
 {% block header_css %}
-<link rel="stylesheet" href="{{ url_for('static', filename='viewer.css') }}">
+<link rel="stylesheet" href="{{ url_for('static', path='viewer.css') }}">
 <link href="https://unpkg.com/leaflet@1.6.0/dist/leaflet.css" rel="stylesheet"/>
 {% endblock %}
 {% block content %}
 <div class="mb-5">
-    <h2 class="text-center text-primary mb-4">{{data[0]["id"]}}</h2>
+    <div id="notification_wrapper">
+        <div class="mb-4 alert alert-warning" role="alert">
+            <h4 id="notification_title"></h4>
+            <span id="notification_message"></span>
+        </div>
+    </div>
+    
+    <h2 class="text-center text-primary mb-4">{{user["id"]}}</h2>
     <p class="fs-4 text-secondary">Date of registration: <span class="date_registration"></span></p>
 </div>
 
@@ -91,7 +98,7 @@
 
     <div class="col-md" style="height: 321px;">
         <div class="h-auto p-5 bg-light border rounded-3">
-            <h2 class="atc_callsign">UUEE_DEL</h2>
+            <h2 class="atc_callsign">Callsign</h2>
             <span>
                 <b>Start time:</b> 
                 <span class="atc_start_time"></span>
@@ -133,11 +140,11 @@
 {% block javascript_code %}
 <script src="https://unpkg.com/leaflet@1.6.0/dist/leaflet.js"></script>
 <script type="text/javascript">
-    const USER_CID = '{{data[0]["id"]}}';
+    const USER_CID = '{{user["id"]}}';
     const FLIGHTPLANS_API_URL = "/api/request?request_string=members/" + USER_CID + "/flightplans";
     const ATC_API_URL = "/api/request?request_string=members/" + USER_CID + "/atc";
 
-    $(".date_registration").text("{{data[0]['reg_date']}}".replace("T", " "));
+    $(".date_registration").text("{{user['reg_date']}}".replace("T", " "));
 </script>
-<script type="text/javascript" src="{{ url_for('static', filename='viewer.js') }}"></script>
+<script type="text/javascript" src="{{ url_for('static', path='viewer.js') }}"></script>
 {% endblock %}