Skip to content

Commit 3f169b7

Browse files
committed
feat: update docs, readme, version
1 parent 39297be commit 3f169b7

File tree

4 files changed

+20
-5
lines changed

4 files changed

+20
-5
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
## Broker-agnostic admin pangel for Taskiq
22

3+
Standalone admin panel with all data stored in SQLite database
4+
5+
6+
- [Broker-agnostic admin pangel for Taskiq](#broker-agnostic-admin-pangel-for-taskiq)
7+
- [Previews](#previews)
8+
- [Usage](#usage)
9+
- [Development](#development)
10+
11+
### Previews
312
Tasks Page | Task Details Page
413
:-------------------------:|:-------------------------:
514
![Alt text](./docs/images/preview1.png) | ![Alt text](./docs/images/preview2.png)
@@ -67,7 +76,7 @@ class TaskiqAdminMiddleware(TaskiqMiddleware):
6776
return super().post_execute(message, result)
6877
```
6978

70-
2) Pull the image from DockerHub: `docker pull artur10/taskiq-admin:1.0.0`
79+
2) Pull the image from DockerHub: `docker pull artur10/taskiq-admin:1.1.0`
7180

7281
3) Replace `ACCESS_TOKEN` with any secret enough string and run:
7382
```bash
@@ -76,7 +85,12 @@ docker run -d --rm \
7685
-v ./taskiq-admin-data/:/usr/database/ \
7786
-e TASKIQ_ADMIN_API_TOKEN=supersecret \
7887
--name taskiq-admin \
79-
artur10/taskiq-admin:1.0.0
88+
artur10/taskiq-admin:1.1.0
8089
```
8190

82-
4) Go to `http://localhost:3000/tasks`
91+
4) Go to `http://localhost:3000/tasks`
92+
93+
### Development
94+
1) Run `pnpm install` to install all dependencies
95+
2) Run `pnpm db:push` to create the sqlite database if needed
96+
3) Run `pnpm dev` to run the project

docs/images/preview1.png

-35.3 KB
Loading

docs/images/preview2.png

468 Bytes
Loading

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
"name": "nuxt-app",
33
"private": true,
44
"type": "module",
5-
"version": "1.0.2",
5+
"version": "1.1.0",
66
"scripts": {
77
"build": "nuxt build",
88
"dev": "nuxt dev",
99
"generate": "nuxt generate",
1010
"preview": "nuxt preview",
11-
"postinstall": "nuxt prepare"
11+
"postinstall": "nuxt prepare",
12+
"db:push": "drizzle-kit push"
1213
},
1314
"dependencies": {
1415
"better-sqlite3": "^11.6.0",

0 commit comments

Comments
 (0)