-
Notifications
You must be signed in to change notification settings - Fork 13
Local Environment Developer Instructions
Ryan Gale edited this page Apr 18, 2025
·
2 revisions
- Clone the fluid core repository to your local machine
- Install all dependencies and set up the database
- Start the local server (typically at fluid.lvh.me:3000)
The Droplets Marketplace is accessible via the "droplets marketplace" navigation tab. This page:
- Is rendered through fluid-admin React pages (appears as an iframe in the core fluid repo)
- Shows which droplets are connected and which are available to install
- Allows you to install/connect droplets (creates a company_droplet database entry linking the integration partner and fluid)
- Clone the droplets-template repository
- Follow the setup instructions in the repository
- Start the local server for the droplets template
Once running, configure your droplet through the settings page:
Details Page Section:
- Fill in information that will be displayed on the details page in the marketplace
Droplet Fluid API:
- The UUID will auto-populate after creation
- Add an API key (retrieve from fluid repo's Rails console using company.token)
- Set the base_url (where integrator events are sent to fluid, typically fluid.lvh.me:3000 for local testing)
Host Server Section:
- Set the base_url where your service is hosted (for events from fluid to the integrator)
Marketplace Page Section:
- Set the title that will appear on the droplets marketplace index page
After creating your droplet, you'll need to make it public to appear in the marketplace:
- Open the Rails console in the fluid repository
- Find your droplet record
- Update it to set public: true
- Save the record
- Refresh the droplets marketplace
- Verify your droplet appears in the list of available droplets
- Test installation and connection functionality
- Verify events are being properly sent between fluid and your droplet