Initial commit

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 7
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 7

.github/workflows/flask.yml

@@ -0,0 +1,36 @@
+name: Flask Application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -0,0 +1,3 @@
+venv
+**/__pycache__
+.pytest_cache

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Putu Widyantara Artanta Wibawa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,64 @@
+# flask-app-vercel
+
+![Flask](https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white)
+![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)
+
+Flask application templates hosted on Vercel, included with unit testing and Python modules.
+
+## Structure 📂
+```
+flask-app-vercel
+├── .github
+├── handlers
+├── modules
+├── static
+│   ├── images
+│   ├── scripts
+│   └── styles
+├── templates
+├── tests
+├── .gitignore
+├── LICENSE
+├── README.md
+├── app.py
+├── requirements.txt
+└── vercel.json
+```
+- [.github](.github/) is a folder that used to place Github related stuff, like CI pipeline.
+- [handlers](handlers/) contain handler to handling HTTP request methods.
+- [modules](modules/) contain the main modules of the app.
+- [static](static/) contain static files like images, CSS, and JavaScript files.
+- [templates](templates/) contain the file that will be rendered for display in the browser.
+- [tests](tests/) contain unit test of the app.
+- [.gitignore](.gitignore) is a file to exclude some folders like venv.
+- [LICENSE](LICENSE) is a file that contains the license used in this app.
+- [README.md](README.md) is the file you are reading now.
+- [app.py](app.py) is the main file of this app.
+- [requirements.txt](requirements.txt) is a file that contains a list of dependencies used in this app.
+- [vercel.json](vercel.json) is a file that contains configuration and override the default behavior of Vercel.
+
+## Installation 🛠️
+- Clone the repository:
+```
+git clone https://github.com/putuwaw/flask-app-vercel.git
+```
+- Create a virtual environment:
+```
+python -m venv venv
+```
+- Activate virtual environment:
+```
+source venv/Scripts/activate
+```
+- Install dependencies:
+```
+pip install -r requirements.txt
+```
+- Run app:
+```
+python app.py
+```
+- Run test:
+```
+pytest
+```

app.py

@@ -0,0 +1,9 @@
+from flask import Flask
+from handlers.routes import configure_routes
+
+app = Flask(__name__)
+
+configure_routes(app)
+
+if __name__ == "__main__":
+    app.run(debug=True)

handlers/routes.py

@@ -0,0 +1,9 @@
+from flask import render_template
+from modules import modules
+
+def configure_routes(app):
+    @app.route("/")
+    def index():
+        hello = modules.hello()
+        content = modules.content()
+        return render_template("index.html", hello=hello, content=content)

modules/modules.py

@@ -0,0 +1,10 @@
+def hello():
+    return "Hello, World!"
+
+def content():
+    return '''
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+            Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 
+            Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. 
+            Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+            '''

static/scripts/scripts.js

@@ -0,0 +1 @@
+// scripts.js

static/styles/styles.css

@@ -0,0 +1 @@
+/* style.css */

templates/base.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>{% block title %} {% endblock %}</title>
+        <link rel="icon" type="image/png" href="{{ url_for('static', filename='images/favicon.png') }}" />
+        <link rel="stylesheet" href="{{ url_for('static', filename='styles/styles.css') }}">
+    </head>
+    <body>
+        {% block body %} {% endblock %}
+        <script src="{{ url_for('static', filename='scripts/scripts.js') }}"></script>
+    </body>
+</html>

templates/index.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+{% block title %} Flask App - Vercel {% endblock %}
+{% block body %}
+    <h1>{{hello}}</h1>
+    <p>{{content}}</p>
+{% endblock %}

tests/test_routes.py

@@ -0,0 +1,11 @@
+from flask import Flask
+from handlers.routes import configure_routes
+
+
+def test_index():
+    app = Flask(__name__, template_folder="../templates")
+    configure_routes(app)
+    app.testing = True
+    client = app.test_client()
+    response = client.get('/')
+    assert response.status_code == 200

vercel.json

@@ -0,0 +1,18 @@
+{
+    "builds": [
+        {
+            "src": "app.py",
+            "use": "@vercel/python"
+        },
+        {
+            "src": "static/**",
+            "use": "@vercel/static"
+        }
+    ],
+    "routes": [
+        {
+            "src": "/(.*)",
+            "dest": "app.py"
+        }
+    ]
+}