Already have a Calcom repo clone?
If you have already cloned the calcom repo (from Installation), all you need to do is run the following command to add the API submodule to the existing repository
git-setup.sh api
Now that you have cloned the API repo, you can get up and running by going through the following steps:
Step 1
Copy the .env files from their respective example files:
cp apps/api/.env.example apps/api/.env cp .env.example .env
Step 2
Install packages with yarn:
yarn
Running API server
Run the API with yarn:
yarn workspace @calcom/api dev
On windows, you would need to update the script to explicitly set port to 3002 and run yarn dev under apps/api/package.json
So, it should look something like this after the changes:
"dev": "set PORT=3002 && next dev"
Now, running yarn workspace @calcom/api dev
should start the server.
Open http://localhost:3002 with your browser to see the result.
If you wish to test how API works locally, please check out our guide here.