[cmd] Collect static files on admin command

evamillan · evamillan · commit d968dbd334d5 · 2024-11-26T12:44:23.000+01:00
Collects and installs static files when the 'admin'
command is run.
The UI static files are generated using 'yarn build'.

Signed-off-by: Eva Millán &lt;evamillan@bitergia.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,10 @@
 *.pyo
 build
 
+# Package files
+src/grimoirelab/core/static
+src/grimoirelab/core/templates
+
 # JavaScript files
 node_modules
 dist
diff --git a/pyproject.toml b/pyproject.toml
@@ -21,6 +21,10 @@ packages = [
     { include = "grimoirelab", from = "src" },
 ]
 
+exclude = [
+    "grimoirelab/core/static"
+]
+
 classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
diff --git a/src/grimoirelab/core/app/urls.py b/src/grimoirelab/core/app/urls.py
@@ -1,10 +1,12 @@
 """GrimoireLab URL Configuration"""
 
 
-from django.urls import path, include
+from django.urls import path, include, re_path
+from django.views.generic import TemplateView
 
 from grimoirelab.core.scheduler.urls import urlpatterns as sched_urlpatterns
 
 urlpatterns = [
-    path("scheduler/", include(sched_urlpatterns))
+    path("scheduler/", include(sched_urlpatterns)),
+    re_path(r'^(?!static|scheduler).*$', TemplateView.as_view(template_name="index.html"))
 ]
diff --git a/src/grimoirelab/core/config/settings.py b/src/grimoirelab/core/config/settings.py
@@ -114,7 +114,7 @@
 TEMPLATES = [
     {
         'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [],
+        'DIRS': [BASE_DIR / 'templates'],
         'APP_DIRS': True,
         'OPTIONS': {
             'context_processors': [
@@ -225,7 +225,9 @@
 #
 
 STATIC_URL = '/static/'
-
+STATICFILES_DIRS = [
+    BASE_DIR / 'templates/static'
+]
 
 # UI static files will be copied to the next path when
 # 'collectstatic' is run.
@@ -234,6 +236,10 @@
 
 STATIC_ROOT = os.path.join(BASE_DIR, 'static')
 
+# MEDIA_URL is only needed when DEBUG is set to True.
+# Modify this URL if you want to run the server in developer mode.
+
+MEDIA_URL = 'http://media.localhost/'
 
 #
 # Default primary key field type
diff --git a/src/grimoirelab/core/runner/commands/admin.py b/src/grimoirelab/core/runner/commands/admin.py
@@ -54,6 +54,7 @@ def _setup():
 
     _create_database()
     _setup_database()
+    _install_static_files()
 
     click.secho("\nGrimoirelab configuration completed", fg='bright_cyan')
 
@@ -98,6 +99,20 @@ def _setup_database(database: str = 'default'):
     click.echo()
 
 
+def _install_static_files():
+    """Collect static files and install them."""
+
+    click.secho('## GrimoireLab static files installation\n',
+                fg='bright_cyan')
+
+    django.core.management.call_command('collectstatic',
+                                        ignore=['admin', 'rest_framework'],
+                                        clear=True,
+                                        interactive=False)
+
+    click.echo()
+
+
 @admin.group()
 @click.pass_context
 def queues(ctx: Context):
diff --git a/ui/.eslintrc.cjs b/ui/.eslintrc.cjs
@@ -3,6 +3,9 @@ require('@rushstack/eslint-patch/modern-module-resolution')
 
 module.exports = {
   root: true,
+  env: {
+    node: true
+  },
   extends: [
     'plugin:vue/vue3-essential',
     'plugin:vue/vue3-strongly-recommended',
diff --git a/ui/index.html b/ui/index.html
@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8">
-    <link rel="icon" href="/favicon-grimoirelab.ico">
+    <link rel="icon" href="./src/assets/favicon-grimoirelab.ico">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>GrimoireLab</title>
   </head>
diff --git a/ui/package.json b/ui/package.json
@@ -5,7 +5,7 @@
   "type": "module",
   "scripts": {
     "serve": "vite",
-    "build": "vite build",
+    "build": "vite build --emptyOutDir",
     "preview": "vite preview",
     "test:unit": "vitest",
     "test:e2e": "start-server-and-test preview http://localhost:4173 'cypress run --e2e'",
diff --git a/ui/src/assets/favicon-grimoirelab.ico b/ui/src/assets/favicon-grimoirelab.ico
diff --git a/ui/vite.config.js b/ui/vite.config.js
@@ -1,5 +1,5 @@
 import { fileURLToPath, URL } from 'node:url'
-
+import path from 'path'
 import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
 
@@ -10,5 +10,9 @@ export default defineConfig({
     alias: {
       '@': fileURLToPath(new URL('./src', import.meta.url))
     }
+  },
+  build: {
+    assetsDir: 'static',
+    outDir: path.resolve(__dirname, '../src/', 'grimoirelab', 'core', 'templates')
   }
 })
