@sensolus/create-snt-agent-app 0.1.0 → 0.1.1

package/template/backend/db_config.py

@@ -0,0 +1,16 @@
+import os
+from dotenv import load_dotenv
+from pathlib import Path
+
+# Load .env file from project root
+env_path = Path(__file__).parent.parent / '.env'
+load_dotenv(env_path)
+
+
+def get_database_uri():
+    host = os.getenv('DB_HOST', 'localhost')
+    port = os.getenv('DB_PORT', '5432')
+    db = os.getenv('DB_NAME', '{{APP_NAME}}')
+    user = os.getenv('DB_USER', 'snt')
+    password = os.getenv('DB_PASSWORD', 'snt')
+    return f'postgresql://{user}:{password}@{host}:{port}/{db}'

package/template/backend/extensions.py

@@ -0,0 +1,3 @@
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()

package/template/backend/init_db.py

@@ -0,0 +1,75 @@
+"""
+Database initialization script.
+Run before starting gunicorn to ensure the database exists and migrations are applied.
+"""
+import os
+import sys
+import logging
+
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s [%(levelname)s] %(message)s',
+    datefmt='%Y-%m-%d %H:%M:%S'
+)
+logger = logging.getLogger(__name__)
+
+# Ensure backend/ is on the path
+sys.path.insert(0, os.path.dirname(__file__))
+
+from db_config import get_database_uri
+from sqlalchemy import create_engine, text
+
+
+def ensure_database():
+    uri = get_database_uri()
+    db_name = os.getenv('DB_NAME', '{{APP_NAME}}')
+
+    # Connect to 'postgres' maintenance DB to check/create ours
+    maintenance_uri = uri.rsplit('/', 1)[0] + '/postgres'
+    engine = create_engine(maintenance_uri, isolation_level='AUTOCOMMIT')
+    with engine.connect() as conn:
+        exists = conn.execute(
+            text("SELECT 1 FROM pg_database WHERE datname = :name"),
+            {'name': db_name}
+        ).fetchone()
+        if not exists:
+            conn.execute(text(f'CREATE DATABASE "{db_name}"'))
+            logger.info(f"Created database '{db_name}'")
+        else:
+            logger.info(f"Database '{db_name}' already exists")
+    engine.dispose()
+
+
+def repair_dirty_state():
+    """One-time fix: drop dirty tables left by failed migration races."""
+    uri = get_database_uri()
+    engine = create_engine(uri, isolation_level='AUTOCOMMIT')
+    with engine.connect() as conn:
+        tables = [row[0] for row in conn.execute(
+            text("SELECT tablename FROM pg_tables WHERE schemaname = 'public'")
+        )]
+        if 'favourite_organisations' in tables and 'alembic_version' in tables:
+            # Check if alembic is stuck on a revision that no longer exists (e.g. 002 was removed)
+            row = conn.execute(text("SELECT version_num FROM alembic_version")).fetchone()
+            if row and row[0] not in ('001',):
+                logger.info(f"Repairing dirty alembic state (stuck at {row[0]})...")
+                conn.execute(text("DROP TABLE IF EXISTS favourite_organisations CASCADE"))
+                conn.execute(text("DROP TABLE IF EXISTS alembic_version CASCADE"))
+                logger.info("Cleaned up — migrations will re-run from scratch")
+    engine.dispose()
+
+
+def run_migrations():
+    from app import app
+    from flask_migrate import upgrade
+
+    with app.app_context():
+        logger.info("Running database migrations...")
+        upgrade()
+        logger.info("Database migrations complete")
+
+
+if __name__ == '__main__':
+    ensure_database()
+    repair_dirty_state()
+    run_migrations()

package/template/backend/migrations/README

@@ -0,0 +1 @@
+Single-database configuration for Flask.

package/template/backend/migrations/alembic.ini

@@ -0,0 +1,50 @@
+# A generic, single database configuration.
+
+[alembic]
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic,flask_migrate
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[logger_flask_migrate]
+level = INFO
+handlers =
+qualname = flask_migrate
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

package/template/backend/migrations/env.py

@@ -0,0 +1,113 @@
+import logging
+from logging.config import fileConfig
+
+from flask import current_app
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+fileConfig(config.config_file_name)
+logger = logging.getLogger('alembic.env')
+
+
+def get_engine():
+    try:
+        # this works with Flask-SQLAlchemy<3 and Alchemical
+        return current_app.extensions['migrate'].db.get_engine()
+    except (TypeError, AttributeError):
+        # this works with Flask-SQLAlchemy>=3
+        return current_app.extensions['migrate'].db.engine
+
+
+def get_engine_url():
+    try:
+        return get_engine().url.render_as_string(hide_password=False).replace(
+            '%', '%%')
+    except AttributeError:
+        return str(get_engine().url).replace('%', '%%')
+
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+config.set_main_option('sqlalchemy.url', get_engine_url())
+target_db = current_app.extensions['migrate'].db
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def get_metadata():
+    if hasattr(target_db, 'metadatas'):
+        return target_db.metadatas[None]
+    return target_db.metadata
+
+
+def run_migrations_offline():
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url, target_metadata=get_metadata(), literal_binds=True
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    # this callback is used to prevent an auto-migration from being generated
+    # when there are no changes to the schema
+    # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
+    def process_revision_directives(context, revision, directives):
+        if getattr(config.cmd_opts, 'autogenerate', False):
+            script = directives[0]
+            if script.upgrade_ops.is_empty():
+                directives[:] = []
+                logger.info('No changes in schema detected.')
+
+    conf_args = current_app.extensions['migrate'].configure_args
+    if conf_args.get("process_revision_directives") is None:
+        conf_args["process_revision_directives"] = process_revision_directives
+
+    connectable = get_engine()
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=get_metadata(),
+            **conf_args
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

package/template/backend/migrations/script.py.mako

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

package/template/backend/migrations/versions/001_add_favourite_organisations.py

@@ -0,0 +1,31 @@
+"""Add favourite_organisations table.
+
+Revision ID: 001
+Revises:
+Create Date: 2026-05-16
+"""
+from alembic import op
+import sqlalchemy as sa
+
+revision = '001'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        'favourite_organisations',
+        sa.Column('id', sa.Integer(), primary_key=True),
+        sa.Column('user_key', sa.String(255), nullable=False),
+        sa.Column('org_id', sa.Integer(), nullable=False),
+        sa.Column('created_at', sa.DateTime(), nullable=False, server_default=sa.text('now()')),
+    )
+    op.create_index('ix_favourite_organisations_user_key', 'favourite_organisations', ['user_key'])
+    op.create_unique_constraint('uq_user_org', 'favourite_organisations', ['user_key', 'org_id'])
+
+
+def downgrade():
+    op.drop_constraint('uq_user_org', 'favourite_organisations', type_='unique')
+    op.drop_index('ix_favourite_organisations_user_key', table_name='favourite_organisations')
+    op.drop_table('favourite_organisations')

package/template/backend/migrations/versions/002_add_org_daily_stats.py

@@ -0,0 +1,36 @@
+"""Add org_daily_stats table.
+
+Revision ID: 002
+Revises: 001
+Create Date: 2026-06-08
+"""
+from alembic import op
+import sqlalchemy as sa
+
+revision = '002'
+down_revision = '001'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        'org_daily_stats',
+        sa.Column('id', sa.Integer(), primary_key=True),
+        sa.Column('org_id', sa.Integer(), nullable=False),
+        sa.Column('org_name', sa.String(255)),
+        sa.Column('snapshot_date', sa.Date(), nullable=False),
+        sa.Column('tracker_count', sa.Integer(), nullable=False, server_default='0'),
+        sa.Column('user_count', sa.Integer(), nullable=False, server_default='0'),
+        sa.Column('captured_at', sa.DateTime(), nullable=False, server_default=sa.text('now()')),
+    )
+    op.create_index('ix_org_daily_stats_org_id', 'org_daily_stats', ['org_id'])
+    op.create_index('ix_org_daily_stats_snapshot_date', 'org_daily_stats', ['snapshot_date'])
+    op.create_unique_constraint('uq_org_day', 'org_daily_stats', ['org_id', 'snapshot_date'])
+
+
+def downgrade():
+    op.drop_constraint('uq_org_day', 'org_daily_stats', type_='unique')
+    op.drop_index('ix_org_daily_stats_snapshot_date', table_name='org_daily_stats')
+    op.drop_index('ix_org_daily_stats_org_id', table_name='org_daily_stats')
+    op.drop_table('org_daily_stats')

package/template/backend/models.py

@@ -0,0 +1,31 @@
+from datetime import datetime, timezone
+from extensions import db
+
+
+class FavouriteOrganisation(db.Model):
+    __tablename__ = 'favourite_organisations'
+
+    id = db.Column(db.Integer, primary_key=True)
+    user_key = db.Column(db.String(255), nullable=False, index=True)
+    org_id = db.Column(db.Integer, nullable=False)
+    created_at = db.Column(db.DateTime, nullable=False, default=lambda: datetime.now(timezone.utc))
+
+    __table_args__ = (
+        db.UniqueConstraint('user_key', 'org_id', name='uq_user_org'),
+    )
+
+
+class OrgDailyStat(db.Model):
+    __tablename__ = 'org_daily_stats'
+
+    id = db.Column(db.Integer, primary_key=True)
+    org_id = db.Column(db.Integer, nullable=False, index=True)
+    org_name = db.Column(db.String(255))
+    snapshot_date = db.Column(db.Date, nullable=False, index=True)
+    tracker_count = db.Column(db.Integer, nullable=False, default=0)
+    user_count = db.Column(db.Integer, nullable=False, default=0)
+    captured_at = db.Column(db.DateTime, nullable=False, default=lambda: datetime.now(timezone.utc))
+
+    __table_args__ = (
+        db.UniqueConstraint('org_id', 'snapshot_date', name='uq_org_day'),
+    )

package/template/backend/requirements.txt

@@ -1,2 +1,8 @@
-flask>=3.0
-requests>=2.31
+flask
+flask-apscheduler
+flask-socketio
+flask-sqlalchemy
+flask-migrate
+requests
+python-dotenv
+psycopg2-binary

package/template/eslint.config.js

@@ -1,5 +1,7 @@
 import js from '@eslint/js'
 import react from 'eslint-plugin-react'
+import reactHooks from 'eslint-plugin-react-hooks'
+import globals from 'globals'
 
 /**
  * Guardrails for the locked @sensolus/snt-agent-kit (do not remove):
@@ -14,12 +16,14 @@ export default [
       ecmaVersion: 'latest',
       sourceType: 'module',
       parserOptions: { ecmaFeatures: { jsx: true } },
-      globals: { fetch: 'readonly', console: 'readonly', window: 'readonly', document: 'readonly' },
+      globals: { ...globals.browser },
     },
-    plugins: { react },
+    plugins: { react, 'react-hooks': reactHooks },
     rules: {
+      ...reactHooks.configs.recommended.rules,
       'react/jsx-uses-react': 'error',
       'react/jsx-uses-vars': 'error',
+      'no-unused-vars': ['error', { caughtErrors: 'none' }],
       'no-restricted-imports': ['error', {
         patterns: [{
           group: ['@sensolus/snt-agent-kit/*', '!@sensolus/snt-agent-kit/theme.css'],

package/template/index.html

@@ -1,12 +1,15 @@
-<!doctype html>
+<!DOCTYPE html>
 <html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>{{APP_NAME}}</title>
-  </head>
-  <body>
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Sensolus Organisations Dashboard</title>
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;600;700&display=swap" rel="stylesheet">
+</head>
+<body>
     <div id="root"></div>
     <script type="module" src="/src/main.jsx"></script>
-  </body>
+</body>
 </html>

package/template/infra/docker-compose.yml

@@ -0,0 +1,15 @@
+services:
+  postgres:
+    image: postgis/postgis:17-3.5
+    restart: always
+    ports:
+      - "5432:5432"
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: snt
+      POSTGRES_PASSWORD: snt
+      POSTGRES_DB: {{APP_NAME}}
+
+volumes:
+  pgdata: