@grouparoo/ui-components v0.9.0

Grouparoo

Sync, Segment, and Send your Product Data Everywhere

Focus on building your core product, not integrating with 3rd-party tools. Learn more at www.grouparoo.com

This is the Grouparoo Monorepo, containing the source code for @grouparoo/core and many plugins. If you are looking for an example about how to run or deploy Grouparoo, please visit https://github.com/grouparoo/app-example

Documentation and Guides

• 🦘 Ready to Try Grouparoo?
  • Grouparoo is Open Source, and easy to run on your laptop or in the cloud.
  • → View the Deployment Docs.
• 📚 Want to learn more about how to configure and use Grouparoo?
  • Grouparoo is can be configured without needing to write any code. Learn how to connect to your Sources and Destinations to begin syncing your data.
  • → View the User Guides.
• ⚙️ Want to learn more about how Grouparoo works?
  • Grouparoo is Open Source, and we welcome community contributions. You can add your own plugins to connect to new Sources and Destinations.
  • → View the Development Guide.
• 👨‍👩‍👧‍👧 Want to collaborate with the Community to enhance Grouparoo?
  • Join other Grouparoo Community members to share best practices and tackle problems.
  • → View the Community Guidelines.

Running a Grouparoo Application

This is an abbreviated version of the "Grouparoo Deployment Guide". The full version can be found here.

Deploy to Heroku

The simplest way to see Grouparoo in action is to deploy it to Heroku for free:

Run locally with Docker & Docker Compose

Assuming you have Docker installed:

# in a new directory
curl -L https://www.grouparoo.com/docker-compose --output docker-compose.yml
docker-compose up

Run Locally with Node.js

Use the Grouparoo Generator to bootstrap a new Grouparoo Project:

npx grouparoo generate
# configure postgres and redis, you can modify `.env` as needed
npm start

This will generate a package.json and .env file for configuration.

Populating Demo Data

Use the staging-public app to try things out.

cd apps/staging-public
# populate the system with 1000 profiles, properties, 1000 purchases, groups, and some events
(npx) grouparoo demo-data-purchases

# including the --scale param allows you to control how many profiles you make. e.g. --scale 10 makes 10,000 extra profiles.
(npx) grouparoo demo-data-purchases --scale 10

# populate the system with events
(npx) grouparoo demo-event-stream

Running Tests

Grouparoo uses Jest as our testing framework. To run tests, first make sure you've installed all dependencies in the root of the project.

cd ../
pnpm install

Next, create the test databases:

cd core
./bin/create_test_database

Then you can run the tests. We recommend you run only the test files you're working on. Let our CI server do the bulk of the work:

npm run test path/to/test/file

🦘