MarTech Agents Manager 4.0
ℹ️ Status:
🟢 Production
This repo is used to develop MarTech agents and to provide the script to initialize the MarTech Agents Manager with an appropriate configuration.
Quicklinks
Scope
- [x] 4.0
- [x] landingpages
- [ ] 3.5 (planned)
Table of Contents
Monorepo Apps & Packages
- Remix backend application for returning the MTAM setup script (apps/backend/README.md)
- package for integrating the MTAM setup script (packages/mtam-components/README.md)
- internal package for agent source code agents/README.md
Integration of MTAM
To integrate MTAM into your own application, please proceed as follows:
-
Make sure your app is updated to the newest version of the remix-stack
- After this, you will have "@pit-martech:registry=https://npm.pkg.github.com/" in the
.npmrcof your application and <MTAMInitScript />coming fromimport { MTAMInitScript } from "@pit-martech/mtam-components";in the<body>of your code.
- After this, you will have "@pit-martech:registry=https://npm.pkg.github.com/" in the
-
The endpoint
/mtam/init.jswill be mocked for you locally and on dev deployments.
ℹ️ To learn more about the package for integrating the MTAM setup script, please see (packages/mtam-components/README.md).
Working with the repository
-
Clone the Repo
-
Read the setup guide for the backend application
-
Install all dependencies by running
pnpm iin project root -
Start the backend application by running the remix dev-server in project root:
pnpm run dev
Release Cycle
The code on main will be deployed to production weekdays at 10 AM (GMT+1).
Testing
To have a testable frontend with MTAM being initialised, please do the following:
-
Create a cookie with the name
mtam-debugand give it a value (request the value from one of the owner of this repository) -
Go to the path
/mtam/test
You will get the mtam.js script attached to the body. If you're on live, you will get the live mtam.js, if you're on stage, you will get the stage mtam.js and so on.
To see some Debug information, do the following:
-
Add "?mtamDev=true" as a parameter to the URL
-
Open the debug GUI via the console by executing
MartechAgentsManager.gui()