@@ -45,15 +45,13 @@ curl -X POST "https://your-domain.com/api/v1/feeds" \
45452 . Set ` HTML2RSS_SECRET_KEY ` in ` docker-compose.yml ` .
46463 . Start: ` docker-compose up ` .
4747
48- UI + API run on ` http://localhost:3000 ` . The app exits if the secret key is missing.
48+ UI + API run on ` http://localhost:4000 ` . The app exits if the secret key is missing.
4949
50- ## Development (Dev Container only)
51- We support a single, batteries-included workflow based on the repository's
52- [ Dev Container] ( .devcontainer/README.md ) . Always work inside the Dev Container locally or in
53- GitHub Codespaces—running the app directly on the host is no longer documented or supported.
54- All agents and automation must run inside the Dev Container as well.
50+ ## Development (Dev Container)
51+ Use the repository's [ Dev Container] ( .devcontainer/README.md ) for all local development and tests.
52+ Running the app directly on the host is not supported.
5553
56- Inside the Dev Container, use :
54+ Quick start inside the Dev Container:
5755
5856```
5957make setup
@@ -64,37 +62,29 @@ bundle exec rubocop -F
6462bundle exec rspec
6563```
6664
67- Dev Container app URL: ` http://localhost:3001 ` .
68-
69- ## Frontend Development
70- ```
71- cd frontend
72- npm install
73- npm run dev
74- ```
75- The Ruby server continues to serve the production build while Astro runs with hot reload on port 4321.
65+ Dev URLs: Ruby app at ` http://localhost:4000 ` , Astro dev server at ` http://localhost:4001 ` .
7666
7767## Make Targets
7868
7969| Command | Purpose |
8070| -------------------- | ------------------------------------------------------- |
8171| ` make help ` | List available shortcuts. |
8272| ` make setup ` | Install Ruby and Node dependencies. |
83- | ` make dev ` | Run Ruby (port 3000 ) and Astro (port 4321 ) dev servers. |
73+ | ` make dev ` | Run Ruby (port 4000 ) and Astro (port 4001 ) dev servers. |
8474| ` make dev-ruby ` | Start only the Ruby server. |
85- | ` make dev-frontend ` | Start only the Astro dev server. |
75+ | ` make dev-frontend ` | Start only the Astro dev server (port 4001). |
8676| ` make test ` | Run Ruby and frontend test suites. |
8777| ` make test-ruby ` | Run Ruby specs. |
8878| ` make test-frontend ` | Run frontend unit and contract tests. |
8979| ` make lint ` | Run all linters. |
9080| ` make lintfix ` | Auto-fix lint warnings where possible. |
9181| ` make clean ` | Remove build artefacts. |
9282
93- ## Frontend npm Scripts
83+ ## Frontend npm Scripts (inside Dev Container)
9484
9585| Command | Purpose |
9686| ----------------------- | --------------------------------- |
97- | ` npm run dev ` | Astro dev server with hot reload. |
87+ | ` npm run dev ` | Astro dev server with hot reload (port 4001) . |
9888| ` npm run build ` | Production build. |
9989| ` npm run test:run ` | Unit tests (Vitest). |
10090| ` npm run test:contract ` | Contract tests with MSW. |
0 commit comments