Data Sync - Quick Start
|clientId||string||Your public app identifier to access Portabl's APIs|
|clientSecret||string||Your secret that shall be known only by your private apps to access Portabl's APIs|
Once you have obtained your API keys from the Portabl Console, we can start integrating Data Sync!
Let's configure your environment variables with the API keys you obtained from the console.
.env file from
.env.example in the root directory and fill out the environment variables needed for Data Sync.
cp apps/web/.env.example apps/web/.env
You have two options for running the quickstart example: with Docker or without it.
This repository is configured to be built and run using Docker and Docker Compose.
up: Builds and starts the container.
logs: Tails logs from the container.
stop: Stops the running container.
To start the container, use one of the following commands:
# Sync React make up integration=sync lib=react
If you prefer not to use Docker, follow the steps below:
Run both the frontend and api sample projects in development mode. Choose one of the preset commands based on the library you want to run:
# Sync React yarn dev:sync:react