ui-syncup 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +85 -0
- package/dist/index.js +22560 -0
- package/package.json +35 -0
- package/templates/Dockerfile.template +64 -0
- package/templates/README.md +18 -0
- package/templates/docker-compose.override.template.yml +39 -0
- package/templates/dockerignore.template +63 -0
- package/templates/env.local.template +74 -0
- package/templates/env.production.template +84 -0
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# ui-syncup
|
|
2
|
+
|
|
3
|
+
CLI for managing self-hosted [UI SyncUp](https://github.com/BYKHD/ui-syncup) instances.
|
|
4
|
+
|
|
5
|
+
UI SyncUp is a visual feedback and issue tracking platform for design-to-development collaboration — pin annotations on mockups, create issues from visual feedback, and track them through a structured workflow.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- **Node.js** ≥ 20
|
|
10
|
+
- **Docker** — required by `ui-syncup up` (Supabase runs inside Docker)
|
|
11
|
+
- **Bun** — required to run the full application after `init`
|
|
12
|
+
- **Supabase CLI** — installed automatically if missing, or install manually: `brew install supabase/tap/supabase`
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install -g ui-syncup
|
|
18
|
+
# or
|
|
19
|
+
bun add -g ui-syncup
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Quick Start
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# 1. Clone the repository into a new folder
|
|
26
|
+
ui-syncup init
|
|
27
|
+
|
|
28
|
+
# 2. Start all services (Supabase, migrations, admin user)
|
|
29
|
+
ui-syncup up
|
|
30
|
+
|
|
31
|
+
# 3. Start the development server (from inside the project folder)
|
|
32
|
+
bun dev
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Open [http://localhost:3000](http://localhost:3000) in your browser.
|
|
36
|
+
|
|
37
|
+
## Commands
|
|
38
|
+
|
|
39
|
+
| Command | Description |
|
|
40
|
+
|---------|-------------|
|
|
41
|
+
| `ui-syncup init` | Initialize a new project — creates `.env` files, storage dirs, and config |
|
|
42
|
+
| `ui-syncup up` | Start all services: Supabase, run migrations, create admin user |
|
|
43
|
+
| `ui-syncup down` | Stop all services |
|
|
44
|
+
| `ui-syncup reset` | Reset data to a clean state (preserves config files) |
|
|
45
|
+
| `ui-syncup purge` | Full cleanup — removes all data, volumes, and config |
|
|
46
|
+
|
|
47
|
+
## Global Options
|
|
48
|
+
|
|
49
|
+
| Flag | Description |
|
|
50
|
+
|------|-------------|
|
|
51
|
+
| `-v, --version` | Display CLI version |
|
|
52
|
+
| `--verbose` | Enable verbose output for debugging |
|
|
53
|
+
| `--no-color` | Disable colored output (useful in CI environments) |
|
|
54
|
+
|
|
55
|
+
## Init Modes
|
|
56
|
+
|
|
57
|
+
`ui-syncup init` supports two setup modes:
|
|
58
|
+
|
|
59
|
+
- **Local** — sets up a local development environment with MinIO (S3-compatible storage)
|
|
60
|
+
- **Production** — configures production with Cloudflare R2/AWS S3 and transactional email (Resend or SMTP)
|
|
61
|
+
|
|
62
|
+
## Examples
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
# Initialize in local mode without prompts
|
|
66
|
+
ui-syncup init --mode local
|
|
67
|
+
|
|
68
|
+
# Start with verbose output for debugging
|
|
69
|
+
ui-syncup up --verbose
|
|
70
|
+
|
|
71
|
+
# Skip migrations on startup (if already up to date)
|
|
72
|
+
ui-syncup up --skip-migrations
|
|
73
|
+
|
|
74
|
+
# Full reset (requires typing the confirmation phrase)
|
|
75
|
+
ui-syncup purge
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Repository
|
|
79
|
+
|
|
80
|
+
Source code, issue tracker, and full documentation:
|
|
81
|
+
[github.com/BYKHD/ui-syncup](https://github.com/BYKHD/ui-syncup)
|
|
82
|
+
|
|
83
|
+
## License
|
|
84
|
+
|
|
85
|
+
MIT
|