O96u
f17d79b236
ci / ci (22, ubuntu-latest) (push) Canceled after 0s
GitHub Release / release (push) Canceled after 0s
Publish Docker image / build (linux/amd64, ubuntu-latest, amd64) (push) Canceled after 0s
Publish Docker image / build (linux/arm64, ubuntu-24.04-arm, arm64) (push) Canceled after 0s
Publish Docker image / merge (push) Canceled after 0s
56 lines
1.6 KiB
Markdown
56 lines
1.6 KiB
Markdown
# Local development
|
|
|
|
Full-stack Nuxt 4 development at the repository root. Data defaults to `./data`.
|
|
|
|
## Requirements
|
|
|
|
- Node.js **22**
|
|
- npm **11** (see `packageManager` in `package.json`)
|
|
|
|
## Start
|
|
|
|
```bash
|
|
npm install
|
|
cp .env.example .env # optional
|
|
npm run dev
|
|
```
|
|
|
|
Open `http://localhost:3000/setup` to create the admin account. Data directory defaults to `./data` (`DATA_DIR` overrides).
|
|
|
|
## Common commands
|
|
|
|
| Command | Description |
|
|
| ------- | ----------- |
|
|
| `npm run dev` | Dev server |
|
|
| `npm run build` | Production build |
|
|
| `npm run start` | Run `.output` |
|
|
| `npm run lint` | ESLint |
|
|
| `npm run typecheck` | Type check |
|
|
| `npm test` | Unit tests |
|
|
| `npm run reset-password` | Reset password (optional username) |
|
|
| `npm run slider` | Reset login verification to local slider |
|
|
| `npm run clear-domains` | Clear site/image URL settings from DB (recover from dual-domain lockout) |
|
|
|
|
## Dev-only variables
|
|
|
|
| Variable | Description |
|
|
| -------- | ----------- |
|
|
| `DEV_BYPASS_ACCESS` | `true` bypasses login (skips `/setup`; rarely needed) |
|
|
| `DATA_DIR` | Data directory, default `./data` |
|
|
|
|
Full list: [Environment variables](./configuration.md).
|
|
|
|
## Dual-domain local test
|
|
|
|
Edit `hosts` and follow [Dual-domain separation](./domain-separation.md) for local verification.
|
|
|
|
## Documentation site
|
|
|
|
```bash
|
|
npm run docs:dev
|
|
npm run docs:build
|
|
npm run docs:preview
|
|
```
|
|
|
|
Sources live in `docs-site/`; screenshot sources are in `docs/screenshots/` (including `login.png`, `setup.png`, `setup-restore.png`, etc.), copied to `docs-site/public/screenshots/` before build. Live docs: <https://o96u.github.io/PicHost/>
|