Cal.com

How to Use:

• Ensure you have Node.js (Version: >=18.x) and PostgreSQL installed on your system.
• It's recommended to use Yarn package manager for installing dependencies.

• Clone the Cal.com repository from GitHub or fork it if you plan to distribute the code.
  bash

  git clone https://github.com/calcom/cal.com.git
• Navigate to the project folder:
  bash

  cd cal.com
• Install required packages using Yarn:
  yarn
• Duplicate the .env.example file to .env and set up environment variables like NEXTAUTH_SECRET and CALENDSO_ENCRYPTION_KEY.

• If you have Docker and Docker Compose installed, you can quickly start a local Postgres instance with test users:
  yarn dx
• This command will log the credentials for the local Postgres instance in the console.

• Run the development server:
  yarn dev
• This will start the server locally, allowing you to access Cal.com on http://localhost:3000.

• Approach 1: Use Prisma Studio to add a new user record interactively.
  • Open Prisma Studio:
    yarn db-studio
  • Add a new user record with email, username, password, and empty metadata.
  • Login with the newly created user on http://localhost:3000.
• Approach 2: Seed the local database with dummy users.
  bash

  cd packages/prisma yarn db-seed

• Ensure the environment variable NEXTAUTH_URL is set correctly, typically to http://localhost:3000.
• Run end-to-end tests:
  yarn test-e2e
• View HTML reports:
  bash

  yarn playwright show-report test-results/reports/playwright-html-report

• Cal.com can be deployed using Docker, Railway, or Vercel. Each option has its setup instructions provided in the documentation.
• Choose the deployment method that best suits your requirements and follow the respective setup instructions.