From 8288049ba9fc58bbb80016e38c4e03d43ce71845 Mon Sep 17 00:00:00 2001 From: Steven Ontong Date: Fri, 5 Jul 2024 07:39:43 +0200 Subject: [PATCH 1/2] better readme notes --- DEVELOP.md | 10 ++++++++-- README.md | 4 ++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/DEVELOP.md b/DEVELOP.md index fb88dde..83b0cc8 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -20,16 +20,22 @@ pnpm build The PowerSync service requires Postgres and MongoDB server connections. These configuration details can be specified in a `powersync.yaml` (or JSON) configuration file. -See the [Self hosting demo](https://github.com/powersync-ja/self-host-demo) for examples of starting these services. +See the [Self hosting demo](https://github.com/powersync-ja/self-host-demo) for demos of starting these services. A quick method for running all required services with a handy backend and frontend is to run the following in a checked-out `self-host-demo` folder. ```bash -docker compose up --scale powersync=0 +docker compose -f demos/nodejs/docker-compose.yaml up --scale powersync=0 ``` Note: The `mongo` hostname specified in the MongoDB replica set needs to be accessible by your host machine if using the Mongo service above. +One method to obtain access is to add the following to `/etc/hosts` (on Unix-like operating systems) + +``` +127.0.0.1 mongo +``` + This will start all the services defined in the Self hosting demo except for the PowerSync service - which will be started from this repository. ## Local Configuration diff --git a/README.md b/README.md index 8f3fe54..96ea909 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,6 @@ The service can be started using the public Docker image. See the image [notes]( The PowerSync service code is located in the `service` folder. This project is used to build the `journeyapps/powersync-service` Docker image. -# Notes +# Developing -This mono repo currently relies on `restricted` packages. Currently this repo can only be built in CI. These dependencies will be removed soon. +See the [Notes](./DEVELOP.md) for local development instructions. From 88cafd7c2fc8b1c46655bb0a4b48deeccb76e82d Mon Sep 17 00:00:00 2001 From: Steven Ontong Date: Fri, 5 Jul 2024 07:43:28 +0200 Subject: [PATCH 2/2] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 96ea909..113f620 100644 --- a/README.md +++ b/README.md @@ -47,4 +47,4 @@ The PowerSync service code is located in the `service` folder. This project is u # Developing -See the [Notes](./DEVELOP.md) for local development instructions. +See the [notes](./DEVELOP.md) for local development instructions.