Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions starter-template/.devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "Oddments Catalog",
"image": "mcr.microsoft.com/devcontainers/javascript-node:1-22-bookworm",
"postCreateCommand": "npm install",
"forwardPorts": [5173],
"portsAttributes": {
"5173": {
"label": "Oddments dev server",
"onAutoForward": "notify"
}
},
"customizations": {
"vscode": {
"extensions": [
"svelte.svelte-vscode",
"esbenp.prettier-vscode"
]
}
}
}
17 changes: 16 additions & 1 deletion starter-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ npm install
npm run dev # preview at http://localhost:5173
```

### Codespaces or Dev Containers

This template includes a `.devcontainer/` setup for GitHub Codespaces and local Docker-based development. Open the repo in Codespaces, or use VS Code's **Dev Containers: Reopen in Container** command, then run:

```bash
npm run dev
```

CLI commands work there too:

```bash
npx oddments import template.csv --dry-run
npx oddments covers --dry-run
```

## Adding content

Each exhibit is a Markdown file with YAML frontmatter in `oddments/`.
Expand Down Expand Up @@ -152,7 +167,7 @@ export default {

`imageOrientation` controls how cover images are displayed on cards and exhibit pages. Set it to match the shape of your cover images:

| Value | Card image box | Exhibit page layout |
| Value | Card image box | Exhibit page layout |
| --------------------- | -------------- | ------------------------- |
| `landscape` (default) | 3:2 (wide) | Image stacked above text |
| `portrait` | 2:3 (tall) | Image left, text right |
Expand Down
Loading