Scheduling infrastructure for absolutely everyone.
The open-source Calendly successor.
Learn more »
Discord
·
Website
·
Issues
·
Roadmap
About the Project Scheduling infrastructure for absolutely everyone
The open source Calendly successor. 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 customization.
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.
Recognition Hacker News
Built With
Contact us
Meet our sales team for any commercial inquiries.
Stay Up-to-Date
Cal.com officially launched as v.1.0 on the 15th of September 2021 and we've come a long way so far. Watch releases of this repository to be notified of future updates:
Getting Started
To get a local copy up and running, please follow these simple steps.
Prerequisites
Here is what you need to be able to run Cal.com.
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.
Development Setup
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
If you are on Windows, run the following command on
gitbash
with admin privileges:
>git clone -c core.symlinks=true https://github.com/calcom/cal.com.git
See docs for more details.
Go to the project folder
cd cal.com
Install packages with yarn
yarn
Set up your .env
file
.env.example
to .env
openssl rand -base64 32
to generate a key and add it under NEXTAUTH_SECRET
in the .env
file.openssl rand -base64 24
to generate a key and add it under CALENDSO_ENCRYPTION_KEY
in the .env
file.Setup Node If your Node version does not meet the project's requirements as instructed by the docs, "nvm" (Node Version Manager) allows using Node at the version required by the project:
nvm use
You first might need to install the specific version and then use it:
nvm install && nvm use
You can install nvm from here.
Quick start with yarn dx
- 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 dxDevelopment tip
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' >> .envGitpod Setup
Click the button below to open this project in Gitpod.
This will open a fully configured workspace in your browser with all the necessary dependencies already installed.
Manual setup
Configure environment variables in the .env
file. Replace <user>
, <pass>
, <db-host>
, and <db-port>
with their applicable values
DATABASE_URL='postgresql://<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 local DB
Download and install postgres in your local (if you don't have it already).
Create your own local db by executing createDB <DB name>
Now open your psql shell with the DB you created: psql -h localhost -U postgres -d <DB name>
Inside the psql shell execute \conninfo
. And you will get the following info.
Now extract all the info and add it to your DATABASE_URL. The url would look something like this
postgresql://postgres:postgres@localhost:5432/Your-DB-Name
.
If you don't want to create a local DB. Then you can also consider using services like railway.app or render.
Copy and paste your DATABASE_URL
from .env
to .env.appStore
.
Set a 24 character random string in your .env
file for the CALENDSO_ENCRYPTION_KEY
(You can use a command like openssl rand -base64 24
to generate one).
Set up the database using the Prisma schema (found in packages/prisma/schema.prisma
)
In a development environment, run:
yarn workspace @calcom/prisma db-migrate
In a production environment, run:
yarn workspace @calcom/prisma db-deploy
Run mailhog to view emails sent during development
NOTE: Required when
E2E_TEST_MAILHOG_ENABLED
is "1"
docker pull mailhog/mailhog docker run -d -p 8025:8025 -p 1025:1025 mailhog/mailhog
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 set metadata
to empty {}
(remembering to encrypt your password with BCrypt) and click Save 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 thepackages/prisma/schema.prisma
file.
Open a browser to http://localhost:3000 and login with your just created, first user.
Approach 2
Seed the local db by running
cd packages/prisma yarn db-seed
The above command will populate the local db with dummy users.
E2E-Testing
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 http://localhost:3000
.
# In a terminal just run: yarn test-e2eResolving issues E2E test browsers not installedTo open the last HTML report run:
yarn playwright show-report test-results/reports/playwright-html-report
Run npx playwright install
to download test browsers and resolve the error below when running yarn test-e2e
:
Executable doesn't exist at /Users/alice/Library/Caches/ms-playwright/chromium-1048/chrome-mac/Chromium.app/Contents/MacOS/Chromium
Upgrading from earlier versions
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 changes
yarn 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.
Deployment Docker
The Docker configuration for Cal.com is an effort powered by people within the community.
If you want to contribute to the Docker repository, reply here.
The Docker configuration can be found in our docker repository.
Issues with Docker? Find your answer or open a new discussion here to ask the community.
Cal.com, Inc. does not provide official support for Docker, but we will accept fixes and documentation. Use at your own risk.
Railway
You can deploy Cal.com on Railway using the button above. The team at Railway also have a detailed blog post on deploying Cal.com on their platform.
Vercel
Currently Vercel Pro Plan is required to be able to Deploy this application with Vercel, due to limitations on the number of serverless functions on the free plan.
Render
Elestio
Roadmap
See the roadmap project for a list of proposed features (and known issues). You can change the view to see planned tagged releases.
Repo Activity
Contributing
Please see our contributing guide.
Good First Issues
We have a list of help wanted that contain small features and bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.
Translations
Don't code but still want to contribute? Join our discord and join the #Translate channel and let us know what language you want to translate.
Enabling Content Security Policy
Integrations Obtaining the Google API Credentials
.../auth/calendar.events
, .../auth/calendar.readonly
and select Update.<Cal.com URL>/api/integrations/googlecalendar/callback
and <Cal.com URL>/api/auth/callback/google
replacing Cal.com URL with the URI at which your application runs..env
file as the value for GOOGLE_API_CREDENTIALS
key.Adding google calendar to Cal.com App Store
After adding Google credentials, you can now Google Calendar App to the app store. You can repopulate the App store by running
cd packages/prisma
yarn seed-app-store
You will need to complete a few more steps to activate Google Calendar App. Make sure to complete section "Obtaining the Google API Credentials". After that do the following
<Cal.com URL>/api/auth/callback/google
Obtaining Microsoft Graph Client ID and Secret
<Cal.com URL>/api/integrations/office365calendar/callback
replacing Cal.com URL with the URI at which your application runs.Obtaining Zoom Client ID and Secret
.env
file into the ZOOM_CLIENT_ID
and ZOOM_CLIENT_SECRET
fields.<Cal.com URL>/api/integrations/zoomvideo/callback
replacing Cal.com URL with the URI at which your application runs.meeting:write
.Obtaining Daily API Credentials
.env
file into the DAILY_API_KEY
field in your .env
file.DAILY_SCALE_PLAN
variable to true
in order to use features like video recording.Obtaining Basecamp Client ID and Secret
<Cal.com URL>/api/integrations/basecamp3/callback
replacing Cal.com URL with the URI at which your application runs.BASECAMP3_CLIENT_ID
and BASECAMP3_CLIENT_SECRET
fields.BASECAMP3_CLIENT_SECRET
env variable to {your_domain} ({support_email})
.
For example, Cal.com (support@cal.com)
.Obtaining HubSpot Client ID and Secret
.env
file into the HUBSPOT_CLIENT_ID
and HUBSPOT_CLIENT_SECRET
fields.<Cal.com URL>/api/integrations/hubspot/callback
replacing Cal.com URL with the URI at which your application runs.crm.objects.contacts
Obtaining Webex Client ID and Secret
Obtaining ZohoCRM Client ID and Secret
.env
file into the ZOHOCRM_CLIENT_ID
and ZOHOCRM_CLIENT_SECRET
fields.<Cal.com URL>/api/integrations/zohocrm/callback
replacing Cal.com URL with the URI at which your application runs.Obtaining Zoho Calendar Client ID and Secret
Obtaining Zoho Bigin Client ID and Secret
Workflows Setting up SendGrid for Email reminders
.env
file into the SENDGRID_API_KEY
field.env
file into the SENDGRID_EMAIL
field.env
file into the NEXT_PUBLIC_SENDGRID_SENDER_NAME
field (fallback is Cal.com)Setting up Twilio for SMS reminders
.env
file into the TWILIO_SID
field.env
file into the TWILIO_TOKEN
field.env
file into the TWILIO_PHONE_NUMBER
field.env
file into the NEXT_PUBLIC_SENDER_ID
field (fallback is Cal.com).env
file into the TWILIO_MESSAGING_SID
field.env
file into the TWILIO_VERIFY_SID
fieldLicense
Distributed under the AGPLv3 License. See LICENSE
for more information.
Acknowledgements
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.
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.