diff options
| -rw-r--r-- | DOCS/testing.md | 10 | ||||
| -rw-r--r-- | README.md | 20 |
2 files changed, 30 insertions, 0 deletions
diff --git a/DOCS/testing.md b/DOCS/testing.md index 40eb12f..4b45b3a 100644 --- a/DOCS/testing.md +++ b/DOCS/testing.md @@ -2,6 +2,16 @@ This document outlines the testing procedures for Neko, both locally and in Continuous Integration (CI). +## Prerequisites + +To run the full test suite locally, ensure you have the following installed: + +- **Go (1.24+)** +- **Node.js (20+) & npm** +- **Docker** +- **golangci-lint** + + ## Local Development Developers should run tests locally before pushing changes. The `Makefile` provides several targets for this purpose: @@ -307,6 +307,26 @@ The project underwent a significant modernization phase with the help of Google # Development and Testing +## Local Development Setup + +To contribute to Neko or run the full test suite locally, you will need the following tools: + +- **Go (1.24+)**: For backend development and running tests. +- **Node.js (20+) & npm**: For frontend development and building UI assets. +- **Docker**: For containerized development and verifying the Docker build. +- **SQLite3**: For direct database manipulation and debugging. +- **Pandoc**: Required for `make docs` to generate `readme.html`. +- **golangci-lint**: Required for `make lint` to run static analysis. + +### Quick Start for Developers + +```bash +make all # Clean, rebuild UIs, build binary, and generate docs +make test # Run all backend and frontend tests +make check # Run linting and tests +``` + + ## 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`. |