Skip to content
View packages

GoSeedly Tutoring & Learning Center 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 enrollment helper is required for connected creation, editing and starter setup. It checks the active account and native permissions, compares both the record timestamp and a server-managed revision, preserves unrelated custom fields and unknown session and review values, and refuses to drop an existing row from a save. Deploy it from your authoritative backend source before connected edits. Pipeline presets and workflow drafts remain optional and install inactive. 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 New student intake, Active enrollment, Test prep programs, Re-enrollment and referrals. 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 student enrollments across one week, with 36 recorded sessions covering all six palette subjects plus one label outside it, a recorded no-show and cancellation, and 11 progress reviews spread across every review band. Example edits stay in the current page’s memory and reset on navigation or reload; no fictional family is ever 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-tutoring-learning-center/config.ts to set center 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

One student enrollment is a native contact-linked opportunity with namespaced student, grade, school, guardian and tutor labels, up to eight recorded subject labels, a reference package count and price, enrollment start and next review dates, reference notes, session rows and progress review rows. Two enrollments for one student, or two children in one family, stay independent records; unrelated custom fields are preserved.

Every value on screen is a label, a date, a duration or a short note typed by a member of staff. A session row records a slot the center agreed: it reserves no room, no tutor and no time, creates no native Calendar appointment, detects no conflict and repeats nothing, and an empty cell means only that nobody recorded a session there. A progress review is a staff-written summary with agreed next steps, not a score, a mark, a rubric or a test result, and the grade label is the grade the student is in. Recorded package counts and prices are reference figures: nothing is charged, invoiced, collected, refunded, prorated or recognized as revenue, and no balance is tracked. Subject chip colour comes from an exact match on the recorded label, so a subject your center invents keeps a neutral gray chip instead of borrowing another subject’s colour, and every chip prints its label as text. This is not a learning management system, a curriculum, an assessment or grading system, or a student information system, and it makes no FERPA, COPPA or other compliance claim.

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.