diff --git a/README.md b/README.md index fe11548..bfb8e1b 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,26 @@ Self-hosted secrets management with web UI and REST API. ## Screenshots +![Login](docs/screenshots/01-login.png) +*Clean login interface with dark mode* + ![Secrets Dashboard](docs/screenshots/02-secrets-dashboard.png) -![Permissions](docs/screenshots/06-permissions.png) +*Main dashboard showing secrets management* + +![Secret Revealed](docs/screenshots/03-secret-revealed.png) +*Viewing a secret value with one click* + +![Users Panel](docs/screenshots/04-users-panel.png) +*User management interface* + +![Tokens Panel](docs/screenshots/05-tokens-panel.png) +*API token management* + +![Permissions Panel](docs/screenshots/06-permissions-panel.png) +*Permission configuration for tokens* + +![Login with Cloudflare Turnstile](docs/screenshots/07-login-with-captcha.png) +*Login page with Cloudflare Turnstile captcha enabled* ## Installation diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..8f9be8e --- /dev/null +++ b/docs/README.md @@ -0,0 +1,39 @@ +# Documentation + +This directory contains documentation assets for the Secrets Manager project. + +## Structure + +``` +docs/ +├── README.md # This file +└── screenshots/ # Application screenshots for documentation + ├── 01-login.png # Login page + ├── 02-secrets-dashboard.png # Secrets management panel + ├── 03-secret-revealed.png # Secret value revealed + ├── 04-users-panel.png # User management panel + ├── 05-tokens-panel.png # API token management panel + ├── 06-permissions-panel.png # Permission configuration panel + └── 07-login-with-captcha.png # Login with Cloudflare Turnstile captcha +``` + +## Screenshots + +All screenshots are taken at 1280x720 resolution in PNG format and show the application's dark mode interface. + +### Adding New Screenshots + +When updating screenshots: + +1. Start the server: `go run cmd/secretsserver/main.go --admin-password "admin123"` +2. Navigate to `http://127.0.0.1:7770` +3. Capture screenshots of each panel +4. Save them with the naming convention: `##-descriptive-name.png` +5. Update the main README.md to reference new screenshots + +### Screenshot Guidelines + +- Use consistent viewport size (1280x720 or similar) +- Capture the full application interface including header and navigation +- Use realistic but safe example data (no real secrets) +- Ensure dark mode is enabled for consistency diff --git a/docs/screenshots/01-login.png b/docs/screenshots/01-login.png new file mode 100644 index 0000000..d201b14 Binary files /dev/null and b/docs/screenshots/01-login.png differ diff --git a/docs/screenshots/02-secrets-dashboard.png b/docs/screenshots/02-secrets-dashboard.png index c1a6fc7..6e93a84 100644 Binary files a/docs/screenshots/02-secrets-dashboard.png and b/docs/screenshots/02-secrets-dashboard.png differ diff --git a/docs/screenshots/03-secret-revealed.png b/docs/screenshots/03-secret-revealed.png index 8c28f14..3d94945 100644 Binary files a/docs/screenshots/03-secret-revealed.png and b/docs/screenshots/03-secret-revealed.png differ diff --git a/docs/screenshots/04-users-panel.png b/docs/screenshots/04-users-panel.png new file mode 100644 index 0000000..2ac03f8 Binary files /dev/null and b/docs/screenshots/04-users-panel.png differ diff --git a/docs/screenshots/05-tokens-panel.png b/docs/screenshots/05-tokens-panel.png new file mode 100644 index 0000000..bd3f56c Binary files /dev/null and b/docs/screenshots/05-tokens-panel.png differ diff --git a/docs/screenshots/06-permissions-panel.png b/docs/screenshots/06-permissions-panel.png new file mode 100644 index 0000000..6b1bf14 Binary files /dev/null and b/docs/screenshots/06-permissions-panel.png differ diff --git a/docs/screenshots/06-permissions.png b/docs/screenshots/06-permissions.png deleted file mode 100644 index c6563a0..0000000 Binary files a/docs/screenshots/06-permissions.png and /dev/null differ diff --git a/docs/screenshots/07-login-with-captcha.png b/docs/screenshots/07-login-with-captcha.png new file mode 100644 index 0000000..e2f4a6b Binary files /dev/null and b/docs/screenshots/07-login-with-captcha.png differ diff --git a/web/.gitignore b/web/.gitignore index 71b5f42..7386414 100644 --- a/web/.gitignore +++ b/web/.gitignore @@ -1,3 +1,4 @@ node_modules/ dist/ yarn-error.log +tsconfig.tsbuildinfo diff --git a/web/tsconfig.tsbuildinfo b/web/tsconfig.tsbuildinfo deleted file mode 100644 index b715178..0000000 --- a/web/tsconfig.tsbuildinfo +++ /dev/null @@ -1 +0,0 @@ -{"root":["./src/app.tsx","./src/api.ts","./src/main.tsx","./src/types.ts","./src/vite-env.d.ts","./src/components/button.tsx","./src/components/input.tsx","./src/components/modal.tsx","./src/components/spoiler.tsx","./src/components/table.tsx","./src/components/tabs.tsx","./src/components/toast.tsx","./src/hooks/useauth.ts","./src/hooks/userouter.ts","./src/hooks/usetoast.ts","./src/pages/dashboard.tsx","./src/pages/login.tsx","./src/pages/panels/permissionspanel.tsx","./src/pages/panels/secretspanel.tsx","./src/pages/panels/tokenspanel.tsx","./src/pages/panels/userspanel.tsx"],"version":"5.9.3"} \ No newline at end of file