aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md64
1 files changed, 31 insertions, 33 deletions
diff --git a/README.md b/README.md
index 1ef1a99..96507bc 100644
--- a/README.md
+++ b/README.md
@@ -124,37 +124,6 @@ Neko is designed for easy building. Static assets for the frontends are pre-buil
make build # Build final binary
```
-### Development and Testing
-
-Utility scripts and test wrappers are located in the `scripts/` directory:
-- `scripts/clean_test_env.sh`: Resets the test database and kills stray processes.
-- `scripts/run_e2e_safe.sh`: A safe wrapper for running Playwright E2E tests.
-- `scripts/run_e2e.sh`: Standard E2E test runner.
-
-
-### Development with Containers
-
-If you don't have Go or Node installed locally, or prefer an isolated environment, you can use the provided `docker-compose.dev.yaml`. This avoids manual setup and works around some issues with VS Code Dev Containers in certain environments (like Antigravity + Colima).
-
-1. **Start the development environment**:
- ```bash
- docker compose -f docker-compose.dev.yaml up -d --build
- ```
-
-2. **Run tests inside the container**:
- ```bash
- docker compose -f docker-compose.dev.yaml exec neko-dev bash -c "go test ./... && cd frontend && npm install && npm test"
- ```
-
-3. **Get an interactive shell**:
- ```bash
- docker compose -f docker-compose.dev.yaml exec neko-dev bash
- ```
-
-4. **Stop the environment**:
- ```bash
- docker compose -f docker-compose.dev.yaml down
- ```
# Configuration
@@ -360,6 +329,35 @@ The project underwent a significant modernization phase with the help of Google
* **Stability**: Added a comprehensive test suite with high coverage across both backend and frontend.
* **Modern Standards**: Fully adopted Go modules and modern JavaScript build tooling.
-# Feedback
-Pull requests and issues are welcomed at https://github.com/adammathes/neko
+# Development and Testing
+
+Utility scripts and test wrappers are located in the `scripts/` directory:
+- `scripts/clean_test_env.sh`: Resets the test database and kills stray processes.
+- `scripts/run_e2e_safe.sh`: A safe wrapper for running Playwright E2E tests.
+- `scripts/run_e2e.sh`: Standard E2E test runner.
+
+
+## Development with Containers
+
+If you don't have Go or Node installed locally, or prefer an isolated environment, you can use the provided `docker-compose.dev.yaml`. This avoids manual setup and works around some issues with VS Code Dev Containers in certain environments (like Antigravity + Colima).
+
+1. **Start the development environment**:
+ ```bash
+ docker compose -f docker-compose.dev.yaml up -d --build
+ ```
+
+2. **Run tests inside the container**:
+ ```bash
+ docker compose -f docker-compose.dev.yaml exec neko-dev bash -c "go test ./... && cd frontend && npm install && npm test"
+ ```
+
+3. **Get an interactive shell**:
+ ```bash
+ docker compose -f docker-compose.dev.yaml exec neko-dev bash
+ ```
+
+4. **Stop the environment**:
+ ```bash
+ docker compose -f docker-compose.dev.yaml down
+ ```