From de4cfaaa8d8d0fd74aaea271dbd624f5267dabcd Mon Sep 17 00:00:00 2001 From: Brendan Chen Date: Thu, 27 Mar 2025 08:46:53 -0700 Subject: [PATCH] update README --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4f65872..a5bb372 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ -# Interchange Node.js Server +# Interchange Server -This is the server codebase for Interchange, an app for college -transit. +This is the server codebase for Interchange, an app for college transit. ## Setup -You'll need Node.js 20.x installed to run this project. -Clone this repository and run the following: +You'll need Docker + Compose installed to run this project. +Clone this repository and run one of the following: ```bash -$ npm start:dev +# run the standard Node development server and Redis +$ docker compose run dev + +# run with unit/server integration tests +$ docker compose run test + +# run with test data suitable for app integration tests +$ docker compose run app-integration-tests ``` - -This will run `npm install`, generate GraphQL type definitions, -and start the server in developer mode. -