Skip to content
View packages

GoSeedly After-School Enrichment Provider 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 backend helpers are required for connected school terms, host schools, the provider details, the registration inbox and setup. They preserve native account permissions, unrelated custom fields and row history, never name or link a contact deleted in Seedly, refuse common phrasings of children's and families' details, pickup permissions, clearance results, codes, logins and ID numbers in new or changed text, as a guard against accidental entry, not a guarantee (text already stored never hides or locks a record), and check revisions before saving. Deploy them from the authoritative backend source. To update to a later version: in your working tree remove the installed version and install the new one with nothing between, then deploy the backend, then build and deploy the web app. If the removal refuses a file you edited, keep a copy of your edits, put the file back exactly as the installed version's installer wrote it (from your own commit made right after installing it, or by installing that version on a fresh copy of the same Seedly release and copying the file from there), remove and install, then re-apply your edits. Pipelines and workflow drafts are 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 Host school terms, New host schools, Instructor hiring, Family questions and waitlist. 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 Copperkite Clubs, an invented provider, with six invented host schools, eight instructors and twelve school terms across one school year and the next fall on real calendar months: fall classes running, winter proposals and registration, spring, and a summer board that leads with fall registration. On a mid-October day it shows 13 classes running, 129 children registered and all four alerts. Sample edits stay in memory and reset on navigation or reload. Add ?example=1 to the home or custom-view URL. Leave sample mode to return to your real account.

MORE OF THE WORKING DAY

From the first inquiry
to the final handoff.

Editable native forms and document templates give your team a practical starting point.

01 / INTAKE & FOLLOW-UP

Three ready-to-edit forms.

  • Class registration
  • Host school interest
  • Instructor interest

Choose forms individually in Setup & resources, then customize and publish them in the native form builder.

02 / WORKING DOCUMENTS

Three reusable templates.

  • Term proposal
  • Class list sheet
  • End-of-term summary

Open each template in Documents and complete it for the actual job or visit.

03 / THE NEXT STEP

Checklists alongside the work.

Record progress and notes in the kit’s operating views. Keep earlier rows by archiving them, and retain the context for the next person.

Forms collect information for staff review. They do not automatically change the kit’s custom records. Repeating setup preserves existing resource edits.

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-enrichment-provider/config.ts to set workspace name, default pipeline name and currency; terms, the time zone and instructors are records edited in setup and on the Instructors view, 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

Each host school keeps its relationship on its own Seedly company: main contact, room, dismissal bell, hosting days and paperwork as recorded. Each school's term is one contact-linked opportunity holding up to 16 classes (weekday, times, dates, grades, minimum and maximum, instructor, room, fee as recorded, status), up to 400 registrations (a child's first name and grade, the grown-up and their contact, status and the day it was recorded), no-class days, the proposal, flyer and confirmation dates and an editable checklist. The provider's time zone, terms and instructors sit in a small record in account settings, kept at or under 32 KiB.

Termtote records what the office typed. Children are minors, so a child is only ever a first name and a grade, and the shared GoSeedly school guard refuses common phrasings of birth dates and ages, grades and school records, allergies, medication and other health details, learning support, behavior, custody, immigration, lunch, income and foster details, pickup permissions and emergency contacts, background check results, codes, passwords and logins, and card, bank and ID numbers in recorded text and in the native form drafts, as a guard against accidental entry, not a guarantee; the README lists the phrasings it leaves open. Termtote keeps no check-in, sign-out, attendance, pickup authorization or ratio records; a clearance is a status and dates, never a result; fees are recorded one per class and never billed or totalled; nothing is sent. It never says a class, an instructor or a school is safe, cleared, certified, compliant or insured. Four alerts appear in red, counted from each class's first and last session: a class below its minimum after registration closed, no instructor 7 days out, a clearance that expires before the class ends and class dates not confirmed 21 days out. Workflow drafts run when a school term moves into their stage in Seedly, not when one is added at a later stage. Long setup jobs run in steps that stay well inside the database's read limit, and school terms are read page by page, so large accounts keep working.

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.