Skip to content

Build and deploy a CRM adapter

Once you have developed your adapter for a CRM, it is time to try it out. To do that, you will need to deploy your adapter's server to a publicly accessible server

Deploying server to AWS

Technically your adapter's server could be deployed anywhere. You could host it yourself, or deploy it to a third-party like Heroku or AWS. To assist developers, we have provided a serverless config file for AWS deployment under the serverless-deploy.

  1. Customize your environment

    cd rc-unified-crm-extension/serverless-deploy
    cp sample.env.yml env.yml
    

    Then edit env.yml.

  2. Customize your serverless deploy config

    cp sample.serverless.yml serverless.yml
    

    Then edit serverless.yml

  3. Build and deploy the server

    npm run serverless-build
    npm run serverless-deploy
    

Deploying to another platform

If you want to deploy it to other platform. Run npm run build-local and a build folder will be created for you in the build folder. You can then deploy this build folder to any other hosting provider.

Server environment variables

Variable Description
APP_SERVER URL for your backend server
APP_SERVER_SECRET_KEY Key to create secret toke between your server and client
TEST_CRM_CLIENT_ID If CRM uses OAuth, it should be the client ID for OAuth
TEST_CRM_CLIENT_SECRET If CRM uses OAuth, it should be the client secret for OAuth
TEST_CRM_ACCESS_TOKEN_URI If CRM uses OAuth, it should access token url for OAuth
TEST_CRM_REDIRECT_URI You can use the default redirect URI, or change it to yours
DATABASE_URL URL for your database, the default one is for local sqlite database