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
4 changes: 2 additions & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ public; there is no login flow and no token injection.
1. Copy `.env.example` to `.env` and configure required variables
2. The `.env` file contains backend service configuration (Neo4j, MinIO, etc.) for local development
3. Frontend-specific variables must be prefixed with `VITE_` to be accessible in the browser
4. This frontend is not meant to run standalone against a self-hosted backend: point it at an `oswatcher-deploy` stack (Docker Compose orchestration for the GraphQL API, Neo4j, and MinIO). `.env` is conventionally a symlink to `../oswatcher-deploy/.env` when both repos are checked out as siblings.
4. This frontend is not meant to run standalone against a self-hosted backend: point it at an `oswatcher` stack (Docker Compose orchestration for the GraphQL API, Neo4j, and MinIO). `.env` is conventionally a symlink to `../oswatcher/.env` when both repos are checked out as siblings.

#### Build Configuration
- Base path is `/` in all modes: the container and `oswatcher-deploy` serve the app at the domain root
- Base path is `/` in all modes: the container and `oswatcher` serve the app at the domain root

### Documentation Structure
The project includes comprehensive technical reference documentation:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ Vue.js application for exploring operating system analysis data with commit hist

## Quick Start

This frontend is not meant to run standalone against a self-hosted backend: it expects an `oswatcher-deploy` stack (Docker Compose orchestration for the GraphQL API, Neo4j, and MinIO) running alongside it. Clone `oswatcher-deploy` as a sibling directory and follow its setup first.
This frontend is not meant to run standalone against a self-hosted backend: it expects an `oswatcher` stack (Docker Compose orchestration for the GraphQL API, Neo4j, and MinIO) running alongside it. Clone `oswatcher` as a sibling directory and follow its setup first.

```bash
# Install dependencies
npm install

# Copy environment variables
cp .env.example .env
# Edit .env to point at your oswatcher-deploy stack
# (conventionally a symlink to ../oswatcher-deploy/.env)
# Edit .env to point at your oswatcher stack
# (conventionally a symlink to ../oswatcher/.env)

# Start development server
npm run dev
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ if (!apiUri) {

### Standalone vs. OSWatcher Deploy

This frontend does not run standalone against a self-hosted backend. It is meant to be pointed at an `oswatcher-deploy` stack (the Docker Compose orchestration that provides the GraphQL API, Neo4j, and MinIO). When both repos are checked out as siblings, `.env` is conventionally a symlink to `../oswatcher-deploy/.env`.
This frontend does not run standalone against a self-hosted backend. It is meant to be pointed at an `oswatcher` stack (the Docker Compose orchestration that provides the GraphQL API, Neo4j, and MinIO). When both repos are checked out as siblings, `.env` is conventionally a symlink to `../oswatcher/.env`.

### Development Environment

Expand Down
2 changes: 1 addition & 1 deletion vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export default defineConfig({
vue(),
vueJsx()
],
// The container and oswatcher-deploy both serve the app at the domain root.
// The container and oswatcher both serve the app at the domain root.
base: '/',
resolve: {
alias: {
Expand Down
Loading