This commit is contained in:
@@ -6,7 +6,7 @@ Thanks for your interest in Movies Diary! This is a personal project but contrib
|
|||||||
|
|
||||||
1. Fork and clone the repo
|
1. Fork and clone the repo
|
||||||
2. Copy `.env.example` to `.env` and fill in at least `JWT_SECRET` and `OMDB_API_KEY`
|
2. Copy `.env.example` to `.env` and fill in at least `JWT_SECRET` and `OMDB_API_KEY`
|
||||||
3. Install Rust (stable, 2024 edition) and Node.js (for the SPA)
|
3. Install Rust (stable, 2024 edition) and Bun (for the SPA)
|
||||||
4. Run the backend and worker:
|
4. Run the backend and worker:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -17,7 +17,7 @@ cargo run -p worker # event worker (separate terminal)
|
|||||||
5. Run the SPA dev server:
|
5. Run the SPA dev server:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd spa && npm install && npm run dev
|
cd spa && bun install && bun run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
## Before submitting a PR
|
## Before submitting a PR
|
||||||
@@ -32,7 +32,7 @@ Or individually:
|
|||||||
cargo fmt --check
|
cargo fmt --check
|
||||||
cargo clippy -- -D warnings
|
cargo clippy -- -D warnings
|
||||||
cargo test
|
cargo test
|
||||||
cd spa && npx tsc --noEmit
|
cd spa && bunx tsc --noEmit
|
||||||
```
|
```
|
||||||
|
|
||||||
All four must pass. PRs with clippy warnings or failing tests won't be merged.
|
All four must pass. PRs with clippy warnings or failing tests won't be merged.
|
||||||
|
|||||||
@@ -166,12 +166,12 @@ Interactive API documentation is available at runtime:
|
|||||||
The single-page app lives in `spa/` and is served at `/app/` by the backend. For local development:
|
The single-page app lives in `spa/` and is served at `/app/` by the backend. For local development:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd spa && npm install && npm run dev # http://localhost:5173/app/
|
cd spa && bun install && bun run dev # http://localhost:5173/app/
|
||||||
```
|
```
|
||||||
|
|
||||||
Set `CORS_ORIGINS=http://localhost:5173` in the backend `.env` to allow cross-origin API calls during development.
|
Set `CORS_ORIGINS=http://localhost:5173` in the backend `.env` to allow cross-origin API calls during development.
|
||||||
|
|
||||||
For production, `npm run build` outputs to `spa/dist/` which the backend serves statically (included in Docker image automatically).
|
For production, `bun run build` outputs to `spa/dist/` which the backend serves statically (included in Docker image automatically).
|
||||||
|
|
||||||
## Terminal UI (deprecated)
|
## Terminal UI (deprecated)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user