brendan/project-inter-server
1
0
Fork 0
mirror of https://github.com/brendan-ch/project-inter-server.git synced 2026-04-16 23:40:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Brendan Chen
2025-03-27 08:46:53 -07:00
parent e880830e02
commit de4cfaaa8d
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -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.