Requirements
You need a PostgresDB database hosted somewhere. Supabase offer a great free option while Heroku offers a low-cost option.
Getting Started
Local settings
Fork and clone the repository
git clone https://github.com/<your-fork>/cal.com.git
Copy the
.env.example
file inapps/web
, rename it to.env
and fill it with your settings (See manual setup and Obtaining the Google API Credentials)Install packages with
yarn
yarn install
Set up the database using the Prisma schema (found in
packages/prisma/schema.prisma
)yarn workspace @calcom/prisma db-deploy
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 (remembering to encrypt your password with BCrypt) and click
Save 1 Record
to create your first user.Open a browser to port 3000 on your localhost and login with your just created, first user.
Sometimes, yarn install might fail during deployment on Vercel, in which case, you can use YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install
as the install command instead.
Deployment
Create a new project on Vercel
Import from your forked repository
Set the Environment Variables
Set the root directory to
apps/web
Override the build command to
cd ../.. && yarn build --include-dependencies --no-deps
Hit Deploy