A Template project for a Templafy Custom Content Connector API

Overview

1. Fork the template
2. Run locally
3. Test locally
4. Deploy to Azure
5. Configure in Templafy Custom Content Connector

Step 1: Create repository from template

1. Press "Use this template"
2. Clone the repo to your local machine

Step 2: Run locally

1. npm install
2. npm run watch

Step 3: Test locally

1. To test visit: localhost:3000/content/?search=templafy

Alternatively use Postman or similar tools to send the requests and inspect the responses.

Step 4: Deploy

Example: Deploy to Azure

1. create an Azure Web App (Node 16)
2. Press Get Publish Profile and copy all text
3. In github go to Settings > Secrets
4. Create a new secret secrets.AZUREAPPSERVICE_PUBLISHPROFILE , and paste the text from Get Publish Profile
5. Open .github/workflows/deploy_main_to_azure_web_app.yml to adjust the app-name to match the name of your Azure Web App

Step 5: Configure Templafy

1. Enable the Custom Content Connector in the Templafy tenant

Hint: For demo and test purposes the Templafy tenant's Custom Content conector can be configured to work with the local server. Simply use ngrok or similar tools to expose the local server's port 3000 to the internet.