feat: move from yarn to pnpm, optimize Dockerfile, update docs

Author: spikeninja

README.md

@@ -1,75 +1,82 @@
-# Nuxt Minimal Starter
-
-Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
-
-## Setup
-
-Make sure to install dependencies:
-
-```bash
-# npm
-npm install
-
-# pnpm
-pnpm install
-
-# yarn
-yarn install
-
-# bun
-bun install
+## Broker-agnostic admin pangel for Taskiq
+
+Tasks Page | Task Details Page
+:-------------------------:|:-------------------------:
+![Alt text](./docs/images/preview1.png) | ![Alt text](./docs/images/preview2.png)
+
+### Usage
+
+1) Add this middleware to your taskiq broker:
+
+```python
+from typing import Any
+from datetime import datetime, UTC
+
+import httpx
+from taskiq import TaskiqMiddleware, TaskiqResult, TaskiqMessage
+
+TASKIQ_ADMIN_URL = "..." # or your env vars from .env
+TASKIQ_ADMIN_API_TOKEN = "..." # or your env vars from .env
+
+
+class TaskiqAdminMiddleware(TaskiqMiddleware):
+    async def pre_execute(self, message: TaskiqMessage):
+        """"""
+
+        async with httpx.AsyncClient() as client:
+            await client.post(
+                headers={"access-token": TASKIQ_ADMIN_API_TOKEN},
+                url=f"{TASKIQ_ADMIN_URL}/tasks/{message.task_id}/started",
+                json={
+                    "worker": "WIP",
+                    "args": message.args,
+                    "kwargs": message.kwargs,
+                    "taskName": message.task_name,
+                    "startedAt": datetime.now(UTC)
+                    .replace(tzinfo=None)
+                    .isoformat(),
+                },
+            )
+
+        return super().pre_execute(message)
+
+    async def post_execute(
+        self,
+        message: TaskiqMessage,
+        result: TaskiqResult[Any],
+    ):
+        """"""
+
+        async with httpx.AsyncClient() as client:
+            await client.post(
+                headers={"access-token": TASKIQ_ADMIN_API_TOKEN},
+                url=f"{TASKIQ_ADMIN_URL}/tasks/{message.task_id}/executed",
+                json={
+                    "error": result.error
+                    if result.error is None
+                    else repr(result.error),
+                    "result": result.return_value,
+                    "returnValue": result.return_value,
+                    "executionTime": result.execution_time,
+                    "finishedAt": datetime.now(UTC)
+                    .replace(tzinfo=None)
+                    .isoformat(),
+                },
+            )
+
+        return super().post_execute(message, result)
 ```
 
-## Development Server
-
-Start the development server on `http://localhost:3000`:
+2) Pull the image from DockerHub: `docker pull artur10/taskiq-admin:1.0.0`
 
+3) Replace `ACCESS_TOKEN` with any secret enough string and run:
 ```bash
-# npm
-npm run dev
-
-# pnpm
-pnpm dev
-
-# yarn
-yarn dev
-
-# bun
-bun run dev
-```
-
-## Production
-
-Build the application for production:
-
-```bash
-# npm
-npm run build
-
-# pnpm
-pnpm build
-
-# yarn
-yarn build
-
-# bun
-bun run build
-```
-
-Locally preview production build:
-
-```bash
-# npm
-npm run preview
-
-# pnpm
-pnpm preview
-
-# yarn
-yarn preview
-
-# bun
-bun run preview
+docker run -d --rm \
+  -e ACCESS_TOKEN=supersecret \
+  -p "3000:3000" \
+  -v ./taskiq-admin-data/:/usr/database/ \
+  --name taskiq-admin \
+  artur10/taskiq-admin:1.0.0
 ```
 
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+4) Go to `http://localhost:3000/tasks`

docker/Dockerfile

@@ -2,19 +2,44 @@ ARG NODE_VERSION=22.12.0
 
 FROM node:${NODE_VERSION}-slim AS build
 
-WORKDIR /usr/app
+# enable pnpm
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+
+WORKDIR /app
+
+# install dependencies
+COPY ./package.json /app/
+COPY ./pnpm-lock.yaml /app/
+RUN pnpm install --shamefully-hoist
 
+# copy other files
 COPY . ./
 
-RUN yarn install
+# build the app
+RUN pnpm run build
+
+# =======================
+FROM node:${NODE_VERSION}-slim
+
+WORKDIR /usr/app
+
+# .output
+COPY --from=build /app/.output/ /usr/app/.output/
+COPY --from=build /app/entrypoint.sh /usr/app/entrypoint.sh
+
+# add drizzle stuff just to push schema on start
+COPY --from=build /app/drizzle.config.ts /usr/app/drizzle.config.ts
+COPY --from=build /app/src/server/db/schema.ts /usr/app/src/server/db/schema.ts
 
 EXPOSE 3000
 ENV HOST=0.0.0.0 NODE_ENV=production
-
-RUN mkdir -p /usr/database/
 ENV DB_FILE_PATH=/usr/database/database.db
 
-RUN yarn build
+RUN npm install drizzle-kit drizzle-orm dotenv better-sqlite3
+
+RUN mkdir -p /usr/database/
 RUN chmod +x /usr/app/entrypoint.sh
 
 CMD [ "/usr/app/entrypoint.sh" ]

docs/images/preview1.png

@@ -2,6 +2,7 @@
   "name": "nuxt-app",
   "private": true,
   "type": "module",
+  "version": "1.0.0",
   "scripts": {
     "build": "nuxt build",
     "dev": "nuxt dev",
@@ -20,9 +21,9 @@
     "vue-router": "^4.5.0",
     "zod": "^3.23.8"
   },
-  "packageManager": "[email protected]+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447",
+  "packageManager": "[email protected]+sha1.a428b12202bc4f23b17e6dffe730734dae5728e2",
   "devDependencies": {
     "@nuxtjs/tailwindcss": "^6.12.2",
     "@types/better-sqlite3": "^7.6.12"
   }
-}
+}