Skip to content
View packages

GoSeedly Business Directory Kit / INSTALLATION

A clear path
to your workspace.

Bring the kit into your compatible Seedly installation, preserve existing work, and choose the starter content that fits your team.

01

Start with your Seedly project.

Use your separately obtained Seedly CRM 5.8.4 installation with extension API 1, a configured backend, and working authentication. Keep a private source checkpoint, including existing customizations. Use Node.js 20 or newer.

02

Run guided setup.

Extract the kit outside the Seedly source folder. From the kit directory, run node setup.mjs. The check identifies supported integration files, changed files, and destination conflicts before installation.

03

Build and connect.

Deploy the included required helper from your authoritative backend source before connected edits. Follow QUICKSTART.md with your project’s existing package manager. Build the web app, sign in, and open your existing /location/YOUR_LOCATION_ID address. Verify access, navigation, and your important CRM flows.

Install the interface.
Choose the starting content.

Frontend installation and optional account content are separate. The included original directory helper is required for connected creation, editing and starter setup. It preserves native account permissions and unrelated custom fields, and checks the current record state before saving. It exposes no stage mutation at all: the listing sheet’s stage control calls the host’s own pipeline mutation under the same permission, so saving listing details never moves a listing. Deploy the helper from your authoritative backend source before connected edits. Pipeline presets and workflow drafts remain optional. Follow QUICKSTART.md and STARTER_CONTENT.md for the exact integration. The frontend installer does not deploy your backend.

Pick your starting structure.

Starter setup offers Listing onboarding, Claim verification, Featured placement sales, Placement renewal. Select individual pipelines and drafts, or use a suitable existing pipeline with the exact stage needed by the chosen draft.

Adapt each workflow.

All nine workflows remain inactive drafts. Review their native triggers, internal tasks, notes, timing, and assignments before publishing in Seedly. Timed waits do not check whether a task is complete or the stage has changed. These examples do not send customer messages.

Explore sample mode.

Explore twelve fictional listings across six recorded categories, with their claims, placements and inquiries. Example edits stay in the current page’s memory and reset on navigation or reload; sample listings are never inserted into your CRM. Add ?example=1 to the home or custom-view URL. Leave sample mode to return to your real account.

INSTALLING WITH AN AI AGENT?

Give it the context.
Keep your custom work.

Existing records and unrelated custom source do not require starting over. Modified integration files need a deliberate merge.

Start with the copy-and-paste prompt in INSTALL_WITH_AI.md.
Read AGENT_INSTALL.md for routes, permissions, provider wiring, backend contracts, and compatibility requirements.
Run node setup.mjs check "/path/to/seedly" before modifying files.
Preserve existing extensions, providers, account controls, custom pages, and unrelated data.
Use a reviewed merge for changed integration files; never replace them with clean copies or bypass the installer’s fingerprints.
Deploy the required write helper from the authoritative backend source before connected edits; preserve existing functions and authorization.
Build and verify account access, original CRM modules, new screens, saving, and reload behavior before publishing.

Make the workspace
feel like your team.

Edit apps/web/components/devlaunch-business-directory/config.ts to set company name, descriptor, and default pipeline name, then rebuild. The design applies to the entire web installation. Use separate web installations to evaluate different full-interface kits, rather than stacking their installers.

Starter removal, updates, and rollback

Review unused starter additions for removal in Starter setup before removing the frontend. Server checks preserve edited or published workflows and pipelines with jobs or references. The process targets recorded kit additions rather than sweeping account records.

Preserve your local configuration and source edits. Preview frontend removal with node setup.mjs remove "/path/to/seedly" --dry-run. The automatic uninstaller uses a private restoration receipt and refuses to overwrite later edits. Keep that receipt private and out of public hosting or source exports. Removing frontend files does not remove account data or undeploy backend functions.

For an update, follow the documented removal/install process and reapply your preserved changes. A manually merged installation needs its own private change ledger and reviewed source rollback.

What the workspace records

A listing is a native contact-linked opportunity with a namespaced business name, category and subcategory labels, city label, website and phone labels, plan tier, claim record, placement record with its monthly reference, listing notes and inquiry records. The monthly placement reference stays separate from native opportunity value. Two listings for the same business in two categories stay independent. Other custom fields are preserved.

Nothing here is public. There is no directory frontend, no publishing, no SEO, no sitemap and no search ranking, and the website and phone labels are labels. There is no map, geocoding or proximity search, and no scraping, data import or third-party listing feed. Claim verification is a recorded staff decision: no ownership is checked, no document is inspected and no owner is contacted. An inquiry’s routing status records what the office already did; nothing is forwarded or messaged. Placements collect no payment, and a renewal date that has passed is shown as past without changing a tier or cancelling anything. The recorded claim rate returns unavailable rather than an invented zero when there is no valid listing, and reference totals are never added across currencies.

The kit’s original operational screens share the frame with full CRM modules from your own Seedly source. Existing account permissions, feature gates, and configured providers still determine access to those modules.