Skip to content

Commit 2d19d5e

Browse files
committed
PEER-220: Update README
Signed-off-by: SeeuSim <[email protected]>
1 parent 5bc7fbf commit 2d19d5e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

backend/matching/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
11
# Matching Service
2+
3+
## Running with Docker (Standalone)
4+
5+
1. Run this command to build:
6+
```sh
7+
docker build \
8+
-t match-express-local \
9+
--build-arg port=9004 \
10+
-f express.Dockerfile .
11+
```
12+
2. Run this command, from the root folder:
13+
```sh
14+
make db-up
15+
```
16+
17+
3. Run the necessary migrate and seed commands, if you haven't yet.
18+
19+
4. Run this command to expose the container:
20+
```sh
21+
docker run -p 9004:9004 --env-file ./.env.docker match-express-local
22+
```
23+
5. To stop the process, use the Docker UI or CLI with `docker rm -f <container_id>` (The child process loop has issues terminating)
24+
25+
## Running with Docker-Compose (Main config)
26+
27+
Edit the variables in the `.env.compose` file and run `make up` from the root folder.
28+
29+
Any startup instructions will be run from `entrypoint.sh` instead.

0 commit comments

Comments
 (0)