The open-source Calendly alternative.
Learn more »
Slack
·
Website
·
Issues
·
Roadmap
The open source Calendly alternative. You are in charge of your own data, workflow and appearance.
Calendly and other scheduling tools are awesome. It made our lives massively easier. We're using it for business meetings, seminars, yoga classes and even calls with our families. However, most tools are very limited in terms of control and customisations.
That's where Cal.com comes in. Self-hosted or hosted by us. White-label by design. API-driven and ready to be deployed on your own domain. Full control of your events and data.
Support us on Product Hunt
Cal officially launched as v.1.0 on 15th of September, however a lot of new features are coming. Watch releases of this repository to be notified for future updates:
To get a local copy up and running, please follow these simple steps.
Here is what you need to be able to run Cal.
- Node.js (Version: >=14.x <17)
- PostgreSQL
- Yarn (recommended)
If you want to enable any of the available integrations, you may want to obtain additional credentials for each one. More details on this can be found below under the integrations section.
-
Clone the repo into a public GitHub repository (or fork https://github.com/calcom/cal.com/fork). If you plan to distribute the code, keep the source code public to comply with AGPLv3. To clone in a private repository, acquire a commercial license)
git clone https://github.com/calcom/cal.com.git
-
Go to the project folder
cd cal.com
-
Install packages with yarn
yarn
-
Use
openssl rand -base64 32
to generate a key and add it underNEXTAUTH_SECRET
in the .env file.
- Requires Docker and Docker Compose to be installed
- Will start a local Postgres instance with a few test users - the credentials will be logged in the console
yarn dx
Add
NEXT_PUBLIC_DEBUG=1
anywhere in your.env
to get logging information for all the queries and mutations driven by trpc.
echo 'NEXT_PUBLIC_DEBUG=1' >> .env
-
Configure environment variables in the
packages/prisma/.env
file. Replace<user>
,<pass>
,<db-host>
,<db-port>
with their applicable valuesDATABASE_URL='postgresql:https://<user>:<pass>@<db-host>:<db-port>'
If you don't know how to configure the DATABASE_URL, then follow the steps here to create a quick DB using Heroku
-
Create a free account with Heroku.
-
In your new app, go to
Overview
and next toInstalled add-ons
, clickConfigure Add-ons
. We need this to set up our database. -
Once you clicked on
Configure Add-ons
, click onFind more add-ons
and search forpostgres
. One of the options will beHeroku Postgres
- click on that option. -
Once the pop-up appears, click
Submit Order Form
- plan name should beHobby Dev - Free
. -
Once you completed the above steps, click on your newly created
Heroku Postgres
and go to itsSettings
. -
In
Settings
, copy your URI to your Cal.com .env file and replace thepostgresql:https://<user>:<pass>@<db-host>:<db-port>
with it. -
To view your DB, once you add new data in Prisma, you can use Heroku Data Explorer.
-
-
Set a 32 character random string in your .env file for the
CALENDSO_ENCRYPTION_KEY
(You can use a command likeopenssl rand -base64 24
to generate one). -
Set up the database using the Prisma schema (found in
apps/web/prisma/schema.prisma
)yarn workspace @calcom/prisma db-deploy
-
Run (in development mode)
yarn dev
-
Open Prisma Studio to look at or modify the database content:
yarn db-studio
-
Click on the
User
model to add a new user record. -
Fill out the fields
email
,username
,password
, and setmetadata
to empty{}
(remembering to encrypt your password with BCrypt) and clickSave 1 Record
to create your first user.New users are set on a
TRIAL
plan by default. You might want to adjust this behavior to your needs in theapps/web/prisma/schema.prisma
file. -
Open a browser to https://localhost:3000 and login with your just created, first user.
Be sure to set the environment variable NEXTAUTH_URL
to the correct value. If you are running locally, as the documentation within .env.example
mentions, the value should be https://localhost:3000
.
# In a terminal just run:
yarn test-e2e
# To open last HTML report run:
yarn workspace @calcom/web playwright-report
-
Pull the current version:
git pull
-
Check if dependencies got added/updated/removed
yarn
-
Apply database migrations by running one of the following commands:
In a development environment, run:
yarn workspace @calcom/prisma db-migrate
(this can clear your development database in some cases)
In a production environment, run:
yarn workspace @calcom/prisma db-deploy
-
Check for
.env
variables changesyarn predev
-
Start the server. In a development environment, just do:
yarn dev
For a production build, run for example:
yarn build yarn start
-
Enjoy the new version.
The Docker configuration for Cal is an effort powered by people within the community. Cal.com, Inc. does not provide official support for Docker, but we will accept fixes and documentation. Use at your own risk.
If you want to contribute to the Docker repository, reply here.
The Docker configuration can be found in our docker repository.
You can deploy Cal on Railway using the button above. The team at Railway also have a detailed blog post on deploying Cal on their platform.
See the roadmap project for a list of proposed features (and known issues). You can change the view to see planned tagged releases.
Please see our contributing guide.
We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.
- Open Google API Console. If you don't have a project in your Google Cloud subscription, you'll need to create one before proceeding further. Under Dashboard pane, select Enable APIS and Services.
- In the search box, type calendar and select the Google Calendar API search result.
- Enable the selected API.
- Next, go to the OAuth consent screen from the side pane. Select the app type (Internal or External) and enter the basic app details on the first page.
- In the second page on Scopes, select Add or Remove Scopes. Search for Calendar.event and select the scope with scope value
.../auth/calendar.events
,.../auth/calendar.readonly
and select Update. - In the third page (Test Users), add the Google account(s) you'll using. Make sure the details are correct on the last page of the wizard and your consent screen will be configured.
- Now select Credentials from the side pane and then select Create Credentials. Select the OAuth Client ID option.
- Select Web Application as the Application Type.
- Under Authorized redirect URI's, select Add URI and then add the URI
<Cal.com URL>/api/integrations/googlecalendar/callback
replacing Cal.com URL with the URI at which your application runs. - The key will be created and you will be redirected back to the Credentials page. Select the newly generated client ID under OAuth 2.0 Client IDs.
- Select Download JSON. Copy the contents of this file and paste the entire JSON string in the .env file as the value for GOOGLE_API_CREDENTIALS key.
- Open Azure App Registration and select New registration
- Name your application
- Set Who can use this application or access this API? to Accounts in any organizational directory (Any Azure AD directory - Multitenant)
- Set the Web redirect URI to
<Cal.com URL>/api/integrations/office365calendar/callback
replacing Cal.com URL with the URI at which your application runs. - Use Application (client) ID as the MS_GRAPH_CLIENT_ID attribute value in .env
- Click Certificates & secrets create a new client secret and use the value as the MS_GRAPH_CLIENT_SECRET attribute
To test this you will need to create a Slack app for yourself on their apps website.
Copy and paste the app manifest below into the setting on your slack app. Be sure to replace YOUR_DOMAIN
with your own domain or your proxy host if you're testing locally.
App Manifest
display_information:
name: Cal.com Slack
features:
bot_user:
display_name: Cal.com Slack
always_online: false
slash_commands:
- command: /create-event
url: https://YOUR_DOMAIN/api/integrations/slackmessaging/commandHandler
description: Create an event within Cal!
should_escape: false
- command: /today
url: https://YOUR_DOMAIN/api/integrations/slackmessaging/commandHandler
description: View all your bookings for today
should_escape: false
oauth_config:
redirect_urls:
- https://YOUR_DOMAIN/api/integrations/slackmessaging/callback
scopes:
bot:
- chat:write
- commands
- chat:write.public
settings:
interactivity:
is_enabled: true
request_url: https://YOUR_DOMAIN/api/integrations/slackmessaging/interactiveHandler
message_menu_options_url: https://YOUR_DOMAIN/api/integrations/slackmessaging/interactiveHandler
org_deploy_enabled: false
socket_mode_enabled: false
token_rotation_enabled: false
Add the integration as normal - slack app - add. Follow the oauth flow to add it to a server.
Next make sure you have your app running yarn dx
. Then in the slack chat type one of these commands: /create-event
or /today
NOTE: Next you will need to setup a proxy server like ngrok to allow your local host machine to be hosted on a public https server.
- Open Zoom Marketplace and sign in with your Zoom account.
- On the upper right, click "Develop" => "Build App".
- On "OAuth", select "Create".
- Name your App.
- Choose "User-managed app" as the app type.
- De-select the option to publish the app on the Zoom App Marketplace.
- Click "Create".
- Now copy the Client ID and Client Secret to your .env file into the
ZOOM_CLIENT_ID
andZOOM_CLIENT_SECRET
fields. - Set the Redirect URL for OAuth
<Cal.com URL>/api/integrations/zoomvideo/callback
replacing Cal.com URL with the URI at which your application runs. - Also add the redirect URL given above as a allow list URL and enable "Subdomain check". Make sure, it says "saved" below the form.
- You don't need to provide basic information about your app. Instead click at "Scopes" and then at "+ Add Scopes". On the left, click the category "Meeting" and check the scope
meeting:write
. - Click "Done".
- You're good to go. Now you can easily add your Zoom integration in the Cal.com settings.
- Open Daily and sign into your account.
- From within your dashboard, go to the developers tab.
- Copy your API key.
- Now paste the API key to your .env file into the
DAILY_API_KEY
field in your .env file. - If you have the Daily Scale Plan set the
DAILY_SCALE_PLAN
variable totrue
in order to use features like video recording.
- Open HubSpot Developer and sign into your account, or create a new one.
- From within the home of the Developer account page, go to "Manage apps".
- Click "Create app" button top right.
- Fill in any information you want in the "App info" tab
- Go to tab "Auth"
- Now copy the Client ID and Client Secret to your .env file into the
HUBSPOT_CLIENT_ID
andHUBSPOT_CLIENT_SECRET
fields. - Set the Redirect URL for OAuth
<Cal.com URL>/api/integrations/hubspotothercalendar/callback
replacing Cal.com URL with the URI at which your application runs. - In the "Scopes" section at the bottom of the page, make sure you select "Read" and "Write" for scope called
crm.objects.contacts
- Click the "Save" button at the bottom footer.
- You're good to go. Now you can see any booking in Cal.com created as a meeting in HubSpot for your contacts.
- Open Vital and click Get API Keys.
- Create a team with the team name you desire
- Head to the configuration section on the sidebar of the dashboard
- Click on API keys and you'll find your sandbox
api_key
. - Copy your
api_key
toVITAL_API_KEY
in the .env.appStore file. - Open Vital Webhooks and add
<CALCOM BASE URL>/api/integrations/vital/webhook
as webhook for connected applications. - Select all events for the webhook you interested, e.g.
sleep_created
- Copy the webhook secret (
sec...
) toVITAL_WEBHOOK_SECRET
in the .env.appStore file.
Distributed under the AGPLv3 License. See LICENSE
for more information.
Special thanks to these amazing projects which help power Cal.com:
Cal.com is an open startup and Jitsu (an open-source Segment alternative) helps us to track most of the usage metrics.