Referral engine

[joeauyeung]

What does this PR do?

This PR adds a referral engine to Cal.com.

Right now this only creates a referral code and tracks referrals.

Linked to https://github.com/calcom/website/pull/185

Fixes # (issue)

Environment: Staging(main branch) / Production

Type of change

• [x] New feature (non-breaking change which adds functionality)

How should this be tested?

• [ ] Test A
• [ ] Test B

Checklist

• I haven't read the contributing guide
• My code doesn't follow the style guidelines of this project
• I haven't performed a self-review of my own code and corrected any misspellings
• I haven't commented my code, particularly in hard-to-understand areas
• I haven't checked if my PR needs changes to the documentation
• I haven't checked if my changes generate no new warnings
• I haven't added tests that prove my fix is effective or that my feature works
• I haven't checked if new and existing unit tests pass locally with my changes

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
cal	❌ Failed (Inspect)		Aug 17, 2022 at 7:01PM (UTC)
cal-com	❌ Failed (Inspect)		Aug 17, 2022 at 7:01PM (UTC)
nightly-cal	❌ Failed (Inspect)		Aug 17, 2022 at 7:01PM (UTC)
swagger	❌ Failed (Inspect)		Aug 17, 2022 at 7:01PM (UTC)

[ciaranha]

Designs for this feature are here: https://www.figma.com/file/9MOufQNLtdkpnDucmNX10R/%E2%9D%96-Cal-DS-v2.0?node-id=13363%3A84358

[joeauyeung]

@Jaibles or even @shirazdole for the referral email is there a specific design we can do? It feels like it could be a little more "flashier" than our normal booking scheduled emails.

[ciaranha]

@joeauyeung we could use this email template I've designed for the drip campaigns? https://www.figma.com/file/Mt3DdNMRZv4ccuToYuuVWu/Emails?node-id=36%3A187

Do we have content for the email yet? Maybe this will do... https://www.figma.com/file/Mt3DdNMRZv4ccuToYuuVWu/Emails?node-id=108%3A205 @shirazdole please comment in here ☝️ if you have any copy changes or ideas!

[zomars]

I'll copy my comment on Twist here for exposure:

Just a thought. Would it make sense to adopt a “microservice” style for the referral program?

Let me elaborate.

The referrals program only applies to our hosted Cal app. It doesn’t makes much sense for self hosted users to have this in their codebase does it?

My proposal is:

• Have this in the monorepo but…
• Served as another app in apps/referrals
• It can be available in referrals.cal.com also rewritten in app.cal.con/referrals if needed or… be embedded altogether

Thoughts?

[zomars]

Moved to 2.1 to focus on V2

[PeerRich]

I'll copy my comment on Twist here for exposure:

Just a thought. Would it make sense to adopt a “microservice” style for the referral program?

Let me elaborate.

The referrals program only applies to our hosted Cal app. It doesn’t makes much sense for self hosted users to have this in their codebase does it?

My proposal is:

• Have this in the monorepo but…
• Served as another app in apps/referrals
• It can be available in referrals.cal.com also rewritten in app.cal.con/referrals if needed or… be embedded altogether

Thoughts?

I wonder if that's actually true. Mabye self hosters want to have a referral engine. like lets say a telehealth marketplace that is looking to attract more therapists

[PeerRich]

Moved to 2.1 to focus on V2

is that a good idea? Thats 30 days from now, likely causing a ton of more merge conflicts. i mean this looks kinda ready, no? @joeauyeung @zomars

[zomars]

We don't want this code for self-hosted @PeerRich we need to change our approach

[PeerRich]

We don't want this code for self-hosted @PeerRich we need to change our approach

I wonder if that's actually true. Mabye self hosters want to have a referral engine. like lets say a telehealth marketplace that is looking to attract more therapists

[zomars]

But then we would need to maintain and support for it. We don't want to increase core complexity. I stand by my statement.

[PeerRich]

But then we would need to maintain and support for it. We don't want to increase core complexity. I stand by my statement.

sounds good 👌

[zomars]

Closing for now