Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Chore] Readme notes #32

Merged
merged 2 commits into from
Jul 9, 2024
Merged

[Chore] Readme notes #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8288049
better readme notes
stevensJourney Jul 5, 2024
88cafd7
typo
stevensJourney Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions DEVELOP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading