Add svelte

.editorconfig

@@ -19,3 +19,7 @@ indent_style = tab
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.{ts, svelte, scss}]
+indent_style = space
+indent_size = 4

.github/scripts/screenshot.py

@@ -0,0 +1,75 @@
+"""Script for generating screenshots of the main page in ``.github/workflows/screenshot.yml``."""
+
+import re
+from base64 import b64encode
+from json import loads
+from subprocess import check_output
+from time import sleep
+from typing import Dict, List
+
+from selenium import webdriver
+from selenium.webdriver.chrome.options import Options
+from selenium.webdriver.chrome.service import Service
+from selenium.webdriver.common.by import By
+from webdriver_manager.chrome import ChromeDriverManager
+
+
+def main() -> None:
+    """Main function of the script."""
+    # Blacklist url regex expression
+    expr = re.compile(r".*(auth|login|__|<|>|api).*")
+    # Blacklist
+    blacklist: List[str] = []
+
+    # Load all urlpatterns
+    urls: List[Dict[str, str]] = loads(check_output("poetry run python manage.py show_urls -uf json".split()).decode())
+
+    # Initialize Chrome (pre-installed on GitHub Actions machine)
+    chrome_options = Options()
+    chrome_options.add_argument("--headless")
+    # Download appropriate driver version for Chrome
+    driver = webdriver.Chrome(service=Service(ChromeDriverManager().install()), options=chrome_options)
+
+    # Iterate over screen widths
+    for width in [1920, 720, 640, 480, 360]:
+        # Iterate over all urls in urlpatterns
+        for url in urls:
+            # Check if url in blacklist
+            if url["url"] in blacklist:
+                continue
+
+            # Check if url contains url arguments. Drop if hit.
+            if expr.findall(url["url"].lower()):
+                # Add to blacklist
+                blacklist.append(url["url"])
+                continue
+
+            # Get page
+            driver.get("http://localhost:8000" + url["url"])
+
+            # Sleep 1 second, wait for redirects
+            sleep(1)
+
+            # Check if url contains url arguments. Drop if hit.
+            if expr.findall(driver.current_url.lower()):
+                # Add to blacklist
+                blacklist.append(url["url"])
+                continue
+
+            # Set window size to page size (fullpage screenshot)
+            driver.set_window_size(width, driver.execute_script("return document.body.parentNode.scrollHeight"))
+
+            # Sleep more to ensure full page load
+            sleep(2)
+
+            # Save screenshot of body element, avoid scrollbar
+            driver.find_element(by=By.TAG_NAME, value="body").screenshot(
+                f"screenshot-{b64encode((url['url'] + ' (width: ' + str(width) + ')').encode()).decode()}.png"
+            )
+
+    # Properly close Chrome
+    driver.close()
+
+
+if __name__ == "__main__":
+    main()

.github/scripts/upload.py

@@ -0,0 +1,31 @@
+"""Script for uploading screenshots to public storage."""
+
+from base64 import b64decode
+from glob import glob
+from sys import argv
+
+import requests
+
+
+def main(secret_key: str, commit: str) -> str:
+    """Main function to upload screenshots.
+
+    Args:
+        secret_key: Secret key for uploading. Passing directly to API.
+        commit: Commit where screenshot was taken.
+
+    Returns:
+        Link to uploaded screenshots.
+    """
+    for image in glob("screenshot-*.png"):
+        response = requests.post(
+            "https://screen.deta.dev/upload",
+            data={"secret": secret_key, "key": commit, "comment": b64decode(image[11:-4]).decode()},
+            files={"file": open(image, "rb")},
+        )
+
+    return "https://screen.deta.dev/" + response.json()["key"]
+
+
+if __name__ == "__main__":
+    print(main(argv[1], argv[2]))

.github/workflows/test.yml

@@ -47,6 +47,21 @@ jobs:
       with:
         file: ./coverage.xml
 
+    - name: Install node
+      if: ${{ matrix.python-version == '3.10' }}
+      uses: bahmutov/npm-install@v1
+      with:
+        working-directory: svelte
+
+    - name: Check TypeScript types
+      if: ${{ matrix.python-version == '3.10' }}
+      run: npx svelte-check
+
+    - name: Build Svelte
+      if: ${{ matrix.python-version == '3.10' }}
+      working-directory: svelte
+      run: npm run build
+
     - name: Configure git
       if: ${{ matrix.python-version == '3.10' }}
       run: |
@@ -74,3 +89,35 @@ jobs:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         branch: ${{ github.head_ref || github.ref_name }}
 
+    - name: Install screenshot dependencies
+      if: ${{ matrix.python-version == '3.10' }}
+      run: poetry install -E screenshot-script
+
+    - name: Make and run migrations
+      if: ${{ matrix.python-version == '3.10' }}
+      run: |
+        echo "DISABLE_DEBUG_TOOLBAR=True" >> .env
+        poetry run python manage.py makemigrations --noinput
+        poetry run python manage.py makemigrations autodonate --noinput
+        poetry run python manage.py makemigrations api --noinput
+        poetry run python manage.py migrate
+        poetry run python manage.py initconfig
+
+    - name: Run server and screenshot script
+      if: ${{ matrix.python-version == '3.10' }}
+      run: |
+        poetry run python manage.py runserver &
+        sleep 5
+        poetry run python .github/scripts/screenshot.py
+
+    - name: Make screenshot arifacts
+      uses: actions/upload-artifact@v3
+      if: ${{ matrix.python-version == '3.10' }}
+      with:
+        name: screen
+        path: screenshot-*.png
+
+    - name: Upload screenshots
+      if: ${{ matrix.python-version == '3.10' }}
+      run: |
+        poetry run python .github/scripts/upload.py ${{ secrets.BIN_SECRET }} $(git rev-parse --short HEAD)

.gitignore

@@ -2,6 +2,18 @@
 # Created by https://www.toptal.com/developers/gitignore/api/linux,python,windows,pycharm+all,visualstudiocode
 # Edit at https://www.toptal.com/developers/gitignore?templates=linux,python,windows,pycharm+all,visualstudiocode
 
+# svelte
+svelte/node_modules/
+svelte/public/build/
+svelte/dist
+
+# bulma
+bulma/node_modules/
+bulma/dist
+
+# media files
+media/
+
 # decouple
 .env
 settings.ini

README.md

@@ -17,9 +17,16 @@
 
 ## Установка
 
+Установите `git` и `node.js` для вашей платформы.
+
 ```bash
-git clone https://github.com/fire-square/autodonate.git
+git clone --recurse-submodules https://github.com/fire-square/autodonate.git
 cd autodonate
+
+cd svelte
+npm install
+npm run build
+cd ..
 ```
 
 Затем установите `poetry` [рекомендованым путем](https://python-poetry.org/docs/master/#installation).
@@ -42,6 +49,13 @@ curl -sSL https://install.python-poetry.org | python -
 poetry install
 ```
 
+Применим миграции:
+
+```bash
+poetry run python manage.py migrate
+poetry run python manage.py initconfig
+```
+
 ## Спасибо
 
 Этот проект был сгенерирован с помощью [`fire-square-style`](https://github.com/fire-square/fire-square-style).

api/__init__.py

@@ -0,0 +1 @@
+"""API app."""

api/apps.py

@@ -0,0 +1,10 @@
+"""App module for API app."""
+
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    """API configuration."""
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "api"

api/urls.py

@@ -0,0 +1,94 @@
+"""URL patterns for API app."""
+
+from typing import List
+
+from django.urls import include, path
+from django.urls.resolvers import URLPattern
+from rest_framework import generics, mixins, routers, serializers, viewsets
+
+from api.views import urls
+from autodonate.models import Config, Donation, Player, Product
+
+
+class ConfigSerializer(serializers.HyperlinkedModelSerializer):
+    """Serializer for Config model."""
+
+    class Meta:
+        """Meta class."""
+
+        model = Config
+        fields = ["key", "value", "read_only"]
+
+
+class ConfigViewSet(viewsets.ModelViewSet):
+    """Config viewset model."""
+
+    queryset = Config.objects.filter(public=True)
+    serializer_class = ConfigSerializer
+
+
+class ProductSerializer(serializers.HyperlinkedModelSerializer):
+    """Serializer for Product model."""
+
+    class Meta:
+        """Meta class."""
+
+        model = Product
+        fields = ["id", "name", "price", "long_description", "group", "max_in_cart", "image"]
+
+
+class ProductViewSet(viewsets.ModelViewSet):
+    """Product viewset model."""
+
+    queryset = Product.objects.filter(enabled=True)
+    serializer_class = ProductSerializer
+
+
+class PlayerSerializer(serializers.HyperlinkedModelSerializer):
+    """Serializer for Player model."""
+
+    class Meta:
+        """Meta class."""
+
+        model = Player
+        fields = ["nickname"]
+
+
+class PlayerViewSet(generics.RetrieveAPIView, viewsets.GenericViewSet):
+    """Viewset for Player model."""
+
+    queryset = Player.objects.all()
+    serializer_class = PlayerSerializer
+
+
+class DonationSerializer(serializers.HyperlinkedModelSerializer):
+    """Serializer for Donation model."""
+
+    product = ProductSerializer(read_only=True)
+    player = PlayerSerializer(read_only=True)
+
+    class Meta:
+        """Meta class."""
+
+        model = Donation
+        fields = ["id", "product", "player", "date"]
+
+
+class DonationViewSet(viewsets.ModelViewSet):
+    """Serializer for Donation model."""
+
+    queryset = Donation.objects.filter(product__enabled=True)[:6]
+    serializer_class = DonationSerializer
+
+
+router = routers.DefaultRouter()
+router.register(r"config", ConfigViewSet)
+router.register(r"product", ProductViewSet)
+router.register(r"player", PlayerViewSet)
+router.register(r"donation", DonationViewSet)
+
+urlpatterns: List[URLPattern] = [
+    path("", include(router.urls)),
+]
+
+urlpatterns.extend(urls)

api/views.py

@@ -0,0 +1,7 @@
+"""Views module for index app."""
+
+from typing import List
+
+from django.urls.resolvers import URLPattern
+
+urls: List[URLPattern] = []

autodonate/admin.py

@@ -2,11 +2,16 @@
 from django.contrib import admin
 from structlog.stdlib import get_logger
 
-from autodonate.models import Config
+from autodonate.models import Config, Donation, Player, Product
 
 log = get_logger()
 
 
+admin.site.register(Player)
+admin.site.register(Donation)
+admin.site.register(Product)
+
+
 @admin.register(Config)
 class ConfigAdmin(admin.ModelAdmin):
     """Admin Config model."""