da55306a5a
* --init * progress... * add more docs * bunch of changes and added back platform * development guides added * more guides in develop with cal * self hosted WIP * deployments * fix deployment steps * self-hosted guides * .. * Removed the development only sections * Removed 'with Cal.com' * use steps component for steps --------- Co-authored-by: Keith Williams <keithwillcode@gmail.com>
31 lines
1.3 KiB
Plaintext
31 lines
1.3 KiB
Plaintext
---
|
|
title: "How to setup API in a local instance"
|
|
---
|
|
|
|
To test API in your local instance, you have the following pre-requisites:
|
|
|
|
<Steps>
|
|
<Step title="Clone the cal.com repository">
|
|
Please close the cal.com repository. You can do it by following the instructions provided in [Installation](/developing/local-development)
|
|
</Step>
|
|
<Step title="Add license key in .env">
|
|
Add a staging license key that goes in as value for `CALCOM_LICENSE_KEY` in your root `.env` file.
|
|
|
|
You can use the following as staging license key
|
|
```
|
|
1a1f8138-0bfc-4f37-b4af-1e24fd145839
|
|
```
|
|
</Step>
|
|
<Step title="Install API submodule">
|
|
Next, you need to install API submodule by following the instructions provided in [API submodule](/developing/local-development#api)
|
|
</Step>
|
|
<Step title="Start development server and create API key">
|
|
Start the cal.com server using `yarn dev` on localhost and create the test API keys by visiting `/settings/developer/api-keys`
|
|
</Step>
|
|
<Step title="Start API server and test API">
|
|
Start the API server by running `yarn workspace @calcom/api dev` and start testing your API locally
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Info>By default, the app server runs on port 3000 and the API server runs on port 3003</Info>
|