chore: Delete apps/docs directory (#9061)
* fixed timezone dropdown * Delete apps/docs directory Docs have moved to cal.com/docs * nit --------- Co-authored-by: Syed Ali Shahbaz <52925846+alishaz-polymath@users.noreply.github.com>
This commit is contained in:
Peer Richelsen
GitHub
parent
cc2c04e52b
commit
a59450a220
|
|
@ -15,7 +15,6 @@
|
|||
deploy/ @calcom/core
|
||||
scripts/ @calcom/core
|
||||
|
||||
apps/docs @calcom/docs
|
||||
apps/swagger @calcom/docs
|
||||
|
||||
packages/app-store-cli @hariombalhara @calcom/core
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
node_modules
|
||||
.next
|
||||
.DS_Store
|
||||
yarn-error.log
|
||||
dist
|
||||
examples
|
||||
packages
|
||||
|
|
@ -1 +0,0 @@
|
|||
v18
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
.next
|
||||
node_modules
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2020 Shu Ding
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
function getAnchor(text) {
|
||||
return text
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9 ]/g, "")
|
||||
.replace(/[ ]/g, "-")
|
||||
.replace(/ /g, "%20");
|
||||
}
|
||||
|
||||
export default function Anchor({ as, children }) {
|
||||
const anchor = getAnchor(children);
|
||||
const link = `#${anchor}`;
|
||||
const Component = as || "div";
|
||||
return (
|
||||
<Component id={anchor}>
|
||||
<a href={link} className="anchor-link">
|
||||
§
|
||||
</a>
|
||||
{children}
|
||||
</Component>
|
||||
);
|
||||
}
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
import { useState, useEffect } from "react";
|
||||
|
||||
// Define general type for useWindowSize hook, which includes width and height
|
||||
export interface Size {
|
||||
width: number | undefined;
|
||||
height: number | undefined;
|
||||
}
|
||||
// Hook from: https://usehooks.com/useWindowSize/
|
||||
export function useWindowSize(): Size {
|
||||
// Initialize state with undefined width/height so server and client renders match
|
||||
// Learn more here: https://joshwcomeau.com/react/the-perils-of-rehydration/
|
||||
const [windowSize, setWindowSize] = useState<Size>({
|
||||
width: undefined,
|
||||
height: undefined,
|
||||
});
|
||||
useEffect(() => {
|
||||
// Handler to call on window resize
|
||||
function handleResize() {
|
||||
// Set window width/height to state
|
||||
setWindowSize({
|
||||
width: window.innerWidth,
|
||||
height: window.innerHeight,
|
||||
});
|
||||
}
|
||||
// Add event listener
|
||||
window.addEventListener("resize", handleResize);
|
||||
// Call handler right away so state gets updated with initial window size
|
||||
handleResize();
|
||||
// Remove event listener on cleanup
|
||||
return () => window.removeEventListener("resize", handleResize);
|
||||
}, []); // Empty array ensures that effect is only run on mount
|
||||
return windowSize;
|
||||
}
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
/// <reference types="next" />
|
||||
/// <reference types="next/image-types/global" />
|
||||
|
||||
// NOTE: This file should not be edited
|
||||
// see https://nextjs.org/docs/basic-features/typescript for more information.
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
/* eslint-disable @typescript-eslint/no-var-requires */
|
||||
const withNextra = require("nextra")({
|
||||
theme: "nextra-theme-docs",
|
||||
themeConfig: "./theme.config.js",
|
||||
unstable_staticImage: true,
|
||||
});
|
||||
module.exports = withNextra({
|
||||
async rewrites() {
|
||||
return [
|
||||
// This redirects requests recieved at /api to /public-api to workaround nextjs default use of /api.
|
||||
{
|
||||
source: "/api",
|
||||
destination: "/public-api",
|
||||
},
|
||||
];
|
||||
},
|
||||
});
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
{
|
||||
"name": "@calcom/docs",
|
||||
"version": "1.0.0",
|
||||
"private": true,
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"build": "next build",
|
||||
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf .next",
|
||||
"dev": "PORT=4000 next",
|
||||
"lint": "eslint . --ignore-path .gitignore",
|
||||
"lint:fix": "eslint . --ext .ts,.js,.tsx,.jsx --fix",
|
||||
"lint:report": "eslint . --format json --output-file ../../lint-results/docs.json",
|
||||
"start": "PORT=4000 next start",
|
||||
"type-check": "tsc --pretty --noEmit",
|
||||
"type-check:ci": "tsc-absolute --pretty --noEmit"
|
||||
},
|
||||
"author": "Cal.com, Inc.",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"iframe-resizer-react": "^1.1.0",
|
||||
"next": "^13.2.1",
|
||||
"nextra": "^1.1.0",
|
||||
"nextra-theme-docs": "^1.2.2",
|
||||
"react": "^18.2.0",
|
||||
"react-dom": "^18.2.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@calcom/config": "*"
|
||||
}
|
||||
}
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
import type { AppProps } from "next/app";
|
||||
import "nextra-theme-docs/style.css";
|
||||
|
||||
import "./style.css";
|
||||
|
||||
export default function Nextra({ Component, pageProps }: AppProps) {
|
||||
return <Component {...pageProps} />;
|
||||
}
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
---
|
||||
title: Billing
|
||||
---
|
||||
|
||||
# Billing
|
||||
## How the trial works
|
||||
You are given FREE access for 14 days of our PRO subscription, you can use this to test and try out our product and see if it works for you. No credit card is required to sign up and you decide if you want to upgrade to a PRO subscription afterwards.
|
||||
|
||||
## How to cancel the trial
|
||||
If you are looking to cancel the trial and want to downgrade to the free option you can contact our support team where we will be happy to help you make that change!
|
||||
|
||||
## How to upgrade
|
||||
If you are looking at upgrading from our FREE subscription to our PRO subscription, head over to cal.com/upgrade where you can easily upgrade hassle free.
|
||||
|
||||
## How to downgrade
|
||||
1. Go to your [Billing Settings](https://app.cal.com/settings/billing).
|
||||
2. From here you can press the button called `Go to the billing Portal`. That will take you to the page where you can upgrade/downgrade your plan.
|
||||
|
||||
## How to delete your account
|
||||
You can delete your account from within the [Settings](https://app.cal.com/settings/profile) option. Just scroll all the way down and click on `Delete Account`.
|
||||
|
||||
## Purchasing a premium username
|
||||
We've reserved a ton of premium usernames, such as short handles or first names to prevent name squatters. To find out if your username is premium, head over to [cal.com/signup](https://cal.com/signup) and choose your desired username. From here you will be taken straight to checkout and after proceeding your Cal.com account will be created with your desired username.
|
||||
|
||||
## Manage your subscription
|
||||
1. Go to your [Billing Settings](https://app.cal.com/settings/billing).
|
||||
2. From here you can press the button called `Go to the billing Portal`.
|
||||
3. This will take you to an external site provided by Stripe as they deal with all our payments.
|
||||
|
||||
Some users may not be able to access Billing as their billing email is different to their account email. If this is the case, you can change the email associated with your account in [Profile Settings](https://app.cal.com/settings/profile).
|
||||
|
||||
## Subscription for each team member
|
||||
If your team requires multiple event types then each team member has to be subscribed to our paid plan. If that is something that isn’t necessary for your team, you can proceed with your FREE plan.
|
||||
|
||||
## Discount for non-profits and students
|
||||
We offer 50% for non-profit organizations and students. Just raise a ticket with our support team and submit the necessary proof of status.
|
||||
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
---
|
||||
title: Bookings
|
||||
---
|
||||
|
||||
# Bookings
|
||||
|
||||
## What can you do on the bookings page?
|
||||
|
||||
On the bookings page you are able to see upcoming and past events booked through your event type links. This page also lets you cancel or reschedule upcoming events users have scheduled.
|
||||
|
||||
## How to view bookings
|
||||
|
||||
1. Go to [your upcoming and past bookings](https://app.cal.com/bookings/upcoming).
|
||||
2. On this page you can see upcoming and past events booked through your event type links.
|
||||
|
||||
## Reschedule bookings
|
||||
|
||||
1. Go to [your rescheduled bookings](https://app.cal.com/bookings/upcoming).
|
||||
2. Hovering over the event you want to reschedule, click the button saying 'Reschedule'
|
||||
3. Clicking 'Reschedule' will bring you to your Cal booking page. Select a new Time and Date.
|
||||
4. After selecting this you can go ahead and click that 'Reschedule' Button!
|
||||
5. After, you and your attendee will receive a new confirmation email of your new date and time.
|
||||
|
||||
## Cancel bookings
|
||||
|
||||
1. Go to [your cancelled](https://app.cal.com/bookings/cancelled).
|
||||
2. Hovering over the event you want to cancel, click the button saying 'Cancel'
|
||||
3. Once done, you will receive a confirmation message saying 'Really cancel your booking?'. After confirming you can go ahead and click the red 'Cancel' button at the bottom of your screen.
|
||||
4. After, you and your attendee will receive a new confirmation email of your event being cancelled.
|
||||
|
|
@ -1,83 +0,0 @@
|
|||
---
|
||||
title: Contributing
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
||||
|
||||
- Before jumping into a PR be sure to search [existing PRs](https://github.com/calcom/cal.com/pulls) or [issues](https://github.com/calcom/cal.com/issues) for an open or closed item that relates to your submission.
|
||||
|
||||
## Developing
|
||||
|
||||
The development branch is `main`. This is the branch that all pull
|
||||
requests should be made against. The changes on the `main`
|
||||
branch are tagged into a release monthly.
|
||||
|
||||
To develop locally:
|
||||
|
||||
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
|
||||
own GitHub account and then
|
||||
[clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
|
||||
2. Create a new branch:
|
||||
|
||||
```sh
|
||||
git checkout -b MY_BRANCH_NAME
|
||||
```
|
||||
|
||||
3. Install yarn:
|
||||
|
||||
```sh
|
||||
npm install -g yarn
|
||||
```
|
||||
|
||||
4. Install the dependencies with:
|
||||
|
||||
```sh
|
||||
yarn
|
||||
```
|
||||
|
||||
5. Start developing and watch for code changes:
|
||||
|
||||
```sh
|
||||
yarn dev
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
You can build the project with:
|
||||
|
||||
```bash
|
||||
yarn build
|
||||
```
|
||||
|
||||
Please be sure that you can make a full production build before pushing code.
|
||||
|
||||
## Testing
|
||||
|
||||
More info on how to add new tests coming soon.
|
||||
|
||||
### Running tests
|
||||
|
||||
This will run and test all flows in multiple Chromium windows to verify that no critical flow breaks:
|
||||
|
||||
```sh
|
||||
yarn test-e2e
|
||||
```
|
||||
|
||||
## Linting
|
||||
|
||||
To check the formatting of your code:
|
||||
|
||||
```sh
|
||||
yarn lint
|
||||
```
|
||||
|
||||
If you get errors, be sure to fix them before comitting.
|
||||
|
||||
## Making a Pull Request
|
||||
|
||||
- Be sure to [check the "Allow edits from maintainers" option](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) while creating you PR.
|
||||
- If your PR refers to or fixes an issue, be sure to add `refs #XXX` or `fixes #XXX` to the PR description. Replacing `XXX` with the respective issue number. Se more about [Linking a pull request to an issue
|
||||
](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
|
||||
- Be sure to fill the PR Template accordingly.
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
---
|
||||
title: Adding CSS
|
||||
---
|
||||
|
||||
import Callout from "nextra-theme-docs/callout";
|
||||
|
||||
# Adding CSS
|
||||
|
||||
<Callout>
|
||||
Adding or modifying CSS counts as changing the code, so as per [our license](https://github.com/calcom/cal.com/blob/main/LICENSE) you must either open-source your modified version or purchase an enterprise license.
|
||||
</Callout>
|
||||
|
||||
Cal.com uses [TailwindCSS](https://tailwindcss.com) as a replacement for traditional CSS styling within the application, but some people prefer to add CSS styles themselves.
|
||||
|
||||
CSS files should be stored in the `styles` directory within the codebase.
|
||||
|
||||
Within the `styles` directory, you will find a single CSS file, `global.css`. We suggest not to add to this file, and instead create new CSS files and import them into the application. This helps reduce conflicts when pulling in changes that we've made to either of the existing CSS files.
|
||||
|
||||
## Adding new stylesheets
|
||||
Firstly, create the CSS file inside the `styles` directory.
|
||||
|
||||
Then, open the `pages/_app.tsx` file, and you will see the following two lines:
|
||||
```javascript
|
||||
import "../styles/globals.css";
|
||||
```
|
||||
|
||||
Duplicate one of these import statements and change the path to link to your new CSS stylesheet, like so:
|
||||
```javascript
|
||||
import "../styles/your-new-stylesheet.css";
|
||||
```
|
||||
|
||||
<Callout type="warning" emoji="⚠️">
|
||||
These styles will apply to all pages and components in your application.
|
||||
</Callout>
|
||||
|
||||
Due to the global nature of stylesheets, and to avoid conflicts, you may **only import them inside `pages/_app.tsx`**.
|
||||
|
|
@ -1,60 +0,0 @@
|
|||
---
|
||||
title: Contributing to App Store
|
||||
---
|
||||
|
||||
# Contributing to the App Store
|
||||
|
||||
Since Cal.com is open source we encourage developers to create new apps for others to use. This guide is to help you get started.
|
||||
|
||||
## Structure
|
||||
|
||||
All apps can be found under `packages/app-store`. In this folder is `_example` which shows the general structure of an app.
|
||||
|
||||
```sh
|
||||
├──_example
|
||||
|
|
||||
| ├──api
|
||||
| | ├──example.ts
|
||||
| | ├──index.ts
|
||||
|
|
||||
| ├──components
|
||||
| | ├──InstallAppButton.tsx
|
||||
| | ├──index.ts
|
||||
|
|
||||
| ├──lib
|
||||
| | ├──adaptor.ts
|
||||
| | ├──index.ts
|
||||
|
|
||||
| ├──static
|
||||
| | ├──icon.svg
|
||||
|
|
||||
| ├──index.ts
|
||||
| ├──package.json
|
||||
| ├──.env.example
|
||||
| ├──DESCRIPTION.md
|
||||
```
|
||||
|
||||
## Getting Started
|
||||
|
||||
In the `package.json` name your package appropriately and list the dependencies needed for the package.
|
||||
|
||||
Next in the `.env.example` specify the environmental variables (ex. auth token, API secrets) that your app will need. In a comment add a link to instructions on how to obtain the credentials. Create a `.env` with your the filled in environmental variables.
|
||||
|
||||
In `index.js` fill out the meta data that will be rendered on the app page. Under `packages/app-store/index.ts`, import your app and add it under `appStore`. Your app should now appear in the app store.
|
||||
|
||||
Under the `/api` folder, this is where any API calls that are associated with your app will be handled. Since cal.com uses Next.js we use dynamic API routes. In this example if we want to hit `/api/example.ts` the route would be `{BASE_URL}/api/integrations/_example/example`. Export your endpoints in an `index.ts` file under `/api` folder and import them in your main `index.ts` file.
|
||||
|
||||
Under the `/components` folder, this is where the install button for your app should live. Follow the template under `_example` to add your on click action (ex. Redirecting to a log in page or opening a modal).
|
||||
|
||||
The `/lib` folder is where the functions of your app live. For example, when creating a booking with a MS Teams link the function to make the call to grab the link lives in the `/lib` folder. Export your endpoints in an `index.ts` file under `/lib` folder and import them in your main `index.ts` file.
|
||||
|
||||
On the app store page you can customize your apps description by adding a markdown file called `DESCRIPTION.md`. If you do not add one then the description from you `package.json` will be used instead.
|
||||
|
||||
The `/static` folder is where you can store your app icon and any images that your `DESCRIPTION.md` may use.
|
||||
|
||||
## Adding Your App to the App Store
|
||||
To render your app on the app store page, go to `packages/app-store/index.ts`. Import your app into the file and add it to the `appStore` object.
|
||||
|
||||
Under `packages/app-store/components.tsx`, in the `InstallAppButtonMap` object dynamically import your install button. Your install button should live under `{your_app}/components`.
|
||||
|
||||
If you need any help feel free to join us on [Slack](https://cal.com/slack)
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
title: Code styling
|
||||
---
|
||||
|
||||
# Code Styling
|
||||
Keeping our code styles consistent is key to making the repository easy to read and work with.
|
||||
|
||||
We use a number of style guides written by other amazing companies, simply because they are widely used and because we like working with them.
|
||||
|
||||
We don't expect you to study every single rule of each style guide, but these are great reference points as to how your code should be styled. We may reject a pull request if your code style significantly differs from these style guides however.
|
||||
|
||||
## ESLint & Prettier
|
||||
Cal.com uses the ESLint and Prettier formatting tools, and the repository comes with defined rules for each tool. We recommend setting up both tools and using these to help automatically style your code to our guidelines.
|
||||
|
||||
## JavaScript/TypeScript
|
||||
We use the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for all JavaScript and TypeScript code.
|
||||
|
||||
## HTML & CSS
|
||||
We use the [Google HTML/CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html) for any HTML and CSS markup. However, exceptions to the HTML guide apply where JSX differentiates from standard HTML.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
{
|
||||
"migrations": "Migrations",
|
||||
"pre-fill": "Pre-fill fields",
|
||||
"code-styling": "Code styling",
|
||||
"project-structure": "Project structure",
|
||||
"pull-requests": "Pull requests",
|
||||
"adding-css": "Adding CSS",
|
||||
"app-store": "Contributing to App Store"
|
||||
}
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
title: Migrations
|
||||
---
|
||||
|
||||
# Database Migrations
|
||||
As described in the [upgrade guide](https://docs.cal.com/self-hosting/upgrade), you should use the `yarn workspace @calcom/prisma db-migrate` or `yarn workspace @calcom/prisma db-deploy` command to update the database.
|
||||
|
||||
We use database migrations in order to handle changes to the database schema in a more secure and stable way. This is actually very common. The thing is that when just changing the schema in `schema.prisma` without creating migrations, the update to the newer database schema can damage or delete all data in production mode, since the system sometimes doesn't know how to transform the data from A to B. Using migrations, each step is reproducable, transparent and can be undone in a simple way.
|
||||
|
||||
## Creating migrations
|
||||
If you are modifying the codebase and make a change to the `schema.prisma` file, you must create a migration.
|
||||
|
||||
To create a migration for your previously changed `schema.prisma`, simply run the following:
|
||||
```sh
|
||||
yarn workspace @calcom/prisma db-migrate
|
||||
```
|
||||
|
||||
Now, you must create a short name for your migration to describe what changed (for example, "user_add_email_verified"). Then just add and commit it with the corresponding code that uses your new database schema.
|
||||
|
||||
:::caution
|
||||
|
||||
Always keep an eye on what migrations Prisma is generating. Prisma often happily will drop entire columns of data because it can't figure out what to do.
|
||||
|
||||
:::
|
||||
|
||||
## Error: The database schema is not empty
|
||||
Prisma uses a database called `_prisma_migrations` to keep track of which migrations have been applied and which haven't. If your local migrations database doesn't match up with what's in the actual database, then Prisma will throw the following error:
|
||||
```text
|
||||
Error: P3005
|
||||
|
||||
The database schema for `localhost:5432` is not empty. Read more about how to baseline an existing production database: https://pris.ly/d/migrate-baseline
|
||||
```
|
||||
|
||||
In order to fix this, we need to tell Prisma which migrations have already been applied.
|
||||
|
||||
This can be done by running the following command, replacing `migration_name` with each migration that you have already applied:
|
||||
```sh
|
||||
yarn prisma migrate resolve --applied migration_name
|
||||
```
|
||||
|
||||
You will need to run the command for each migration that you want to mark as applied.
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
title: Pre-fill fields
|
||||
---
|
||||
|
||||
# Pre-fill fields
|
||||
|
||||
You can pre-fill a number of fields on the booking form by using their corresponding URL parameters. This can include the user’s name, email, or guests to be added to the booking.
|
||||
|
||||
Usually when they go to the link, all that is needed will be the time of the booking, and the form will be pre-filled with the information given.
|
||||
|
||||
Pre-filling booking fields can save a lot of time and speed up processes with filling out these forms, and assist with a smooth integration with your existing website or app.
|
||||
|
||||
You can pre-fill a user’s name and email address like so:
|
||||
```text
|
||||
cal.com/rick/quick-chat/?email=attendee@example.com&name=John
|
||||
```
|
||||
The data is persisted through the 3 booking pages; and is used to prefill the booking form.
|
||||
|
||||
Guests can also be added to the link, there is also no limit to the amount of guests you wish to add.
|
||||
|
||||
These should be added to your link like this:
|
||||
```text
|
||||
guest=guest1@example.com&guest=guest2@example.com
|
||||
```
|
||||
|
|
@ -1,50 +0,0 @@
|
|||
---
|
||||
title: Project structure
|
||||
---
|
||||
|
||||
# Project Structure
|
||||
|
||||
This page gives an overview of how the codebase is structured so you can easily dive into the Cal.com code.
|
||||
|
||||
Cal.com is written in Next.js, so you will find that we follow Next.js best practices for structure and layouts.
|
||||
|
||||
## Basic folder structure
|
||||
|
||||
The project comprises of the following folder structure:
|
||||
|
||||
```text
|
||||
.github/ - GitHub configuration files
|
||||
ISSUE_TEMPLATE/
|
||||
workflows/
|
||||
.husky/ - Git hooks
|
||||
.vscode/ - VS Code editor configuration
|
||||
components/ - Application components
|
||||
booking/
|
||||
dialog/
|
||||
team/
|
||||
ui/
|
||||
lib/ - Reusable code
|
||||
emails/
|
||||
events/
|
||||
forgot-password/messaging/
|
||||
integrations/CalDav/
|
||||
teams/
|
||||
pages/ - Most of the project lives here
|
||||
[user]/ - Booking pages
|
||||
api/ - The backend API
|
||||
auth/ - Next-Auth.js and other authentication routes
|
||||
availability/
|
||||
bookings/
|
||||
cancel/
|
||||
event-types/
|
||||
integrations/
|
||||
reschedule/
|
||||
settings/
|
||||
team/
|
||||
prisma/ - The database schema and migrations
|
||||
migrations/
|
||||
public/ - Images and static files
|
||||
integrations/
|
||||
styles/
|
||||
test/lib/
|
||||
```
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
---
|
||||
title: Pull requests
|
||||
---
|
||||
|
||||
# Pull Requests
|
||||
|
||||
## Requirements
|
||||
|
||||
We have a number of requirements for PRs to ensure they are as easy to review as possible and to ensure that they are up to standard with the code.
|
||||
|
||||
### Title & Content
|
||||
|
||||
Start by providing a short and concise title. Don’t put something generic (e.g. bug fixes), and instead mention more specifically what your PR achieves, for instance “Fixes dropdown not expanding on settings page”.
|
||||
|
||||
For the PR description, you should go into much greater detail about what your PR adds or fixes. Firstly, the description should include a link to any relevant issues or discussions surrounding the feature or bug that your PR addresses.
|
||||
|
||||
#### Feature PRs
|
||||
|
||||
Give a functional overview of how your feature works, including how the user can use the feature. Then, share any technical details in an overview of how the PR works (e.g. “Once the user enters their password, the password is hashed using BCrypt and stored in the Users database field”).
|
||||
|
||||
#### Bug Fix PRs
|
||||
|
||||
Give an overview of how your PR fixes the bug both as a high-level overview and a technical explanation of what caused the issue and how your PR resolves this.
|
||||
|
||||
Feel free to add a short video or screenshots of what your PR achieves. Loom is a great way of sharing short videos.
|
||||
|
||||
### Code Quality & Styling
|
||||
|
||||
All submitted code must match our [code styling](/docs/code-styling) standards. We will reject pull requests that differ significantly from our standardised code styles.
|
||||
|
||||
All code is automatically checked by Codacy and our linting process, and will notify you if there are any issues with the code that you submit. We require that code passes these quality checks before merging.
|
||||
|
||||
## PR review process
|
||||
|
||||
At least two members of the Calendso team should review and approve any PR before it is merged.
|
||||
|
||||
Once two members of the team have approved this, someone from the team will merge the PR. If you are part of the Calendso team, you should merge your own PRs once you have received both approvals.
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
---
|
||||
title: Event Types
|
||||
---
|
||||
|
||||
# Event Types
|
||||
Event types allow you to create different events for different occasions when booking a time with you in your calendar. These can be named differently, have different time durations and the choice of platform can change.
|
||||
|
||||
## Creating an event type
|
||||
1. Go to [Your Event Types](https://app.cal.com/event-types).
|
||||
2. Click the button at the top right of your screen saying '+ New Event Type'.
|
||||
3. Create the title of your new event.
|
||||
4. Confirm the auto-generated event type URL.
|
||||
5. Create a description on what your event will be used for.
|
||||
6. Decide on the amount of minutes you wish for this event to last for.
|
||||
7. Press 'Continue'
|
||||
8. Your event has now been created!
|
||||
|
||||
## Editing event types
|
||||
1. Go to [Your Event Types](https://app.cal.com/event-types).
|
||||
2. Click anywhere within the box of the event you would like to edit.
|
||||
(From here you can edit the basic settings of your event)
|
||||
3. To get the advanced options, at the bottom of your event setting click 'Show Advanced Settings'
|
||||
4. After you have finished editing the event type, scroll to the bottom of your page and select 'Update'
|
||||
5. Your event type has now been updated.
|
||||
|
||||
## Deleting event types
|
||||
1. Go to [Your Event Types](https://app.cal.com/event-types).
|
||||
2. Click anywhere within the box of the event, just like you would if you were editing the event.
|
||||
3. From this page, just to the right, a button saying 'delete' will appear. Click this and your event will be deleted!
|
||||
|
||||
## How to block a time slot before/after a meeting
|
||||
You can block out a time frame in your calendar only after the meeting. You can do this by selecting `Show advanced settings` of your Event Type. The setting is labeled `Time-slot intervals`.
|
||||
|
||||
## Setting up specific availability for each type of Event
|
||||
Head to `Show advanced settings` of your event. At the bottom you can set up specific availability for different Event Types.
|
||||
|
||||
## Availability not showing on a certain day in your calendar
|
||||
Head over to your event and once you click on `Show advanced settings`, make sure your time zones are correct. Also, check if you have any calendar events scheduled that could overlap with your availability.
|
||||
|
||||
## People can't book me even though there is still a couple of hours left on my availability for today
|
||||
Head over to your event and once you click on `Show advanced settings`, have a look at the `Minimum booking notice`. It probably overlaps with your availability so make sure that notice fits your desired time frame for meetings. For example, if someone wants to book a meeting with you at 16:15 and it’s already 15:30, your 90 minutes minimum booking notice doesn’t allow that meeting to be booked.
|
||||
|
||||
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
title: FAQs
|
||||
---
|
||||
|
||||
# Frequently asked questions
|
||||
|
||||
## Does Cal.com support a custom domain?
|
||||
This is possible with our self-hosted option.
|
||||
|
||||
## Is there a possibility of multi-bookings for events where more people can book at the same time?
|
||||
As it stands this is currently not possible. We always keep an eye on the limitations like these that our users point to us. We’ve had requests in the past for the multi-booking feature and this is on our priority list.
|
||||
|
||||
## How to quickly block further bookings?
|
||||
1. Click on the lower left corner of your dashboard where your username is displayed.
|
||||
2. That initiates a dropdown menu. Click on `Set yourself as away`.
|
||||
|
||||
This is a method to disable your Cal.com account which won't allow any bookings once initiated. However, bookings made before turning on *away mode* will still be booked.
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
---
|
||||
title: Import
|
||||
---
|
||||
|
||||
import Callout from "nextra-theme-docs/callout";
|
||||
|
||||
# Import data from other scheduling tools
|
||||
|
||||
When setting up your Cal.com account via the onboarding process, you can import data from other scheduling tools, such as Calendly or SavvyCal. All that you need to import your data is an access token, which you can retrieve from your Calendly/SavvyCal account.
|
||||
|
||||
Once you've pasted your access token, we import your account data in less than a second.
|
||||
|
||||
Naturally, we take security very seriously when it comes to importing your data from other accounts, so that's why we never store your access token, and use it once to query the Calendly/SavvyCal APIs, populate your account with the data it returns, and then your key is destroyed from memory. All of the importer code can be [freely viewed on GitHub](https://github.com/calcom/cal.com/tree/main/pages/api/import), so you can be assured we're not using your data for malicious purposes.
|
||||
|
||||
## Calendly
|
||||
The following steps will help you retrieve your Calendly access token, which you will need to present at the import screen of the onboarding process.
|
||||
1. Go to the Calendly website and click on **My Account** in the top right
|
||||
2. Now click on **Integrations** in the top right
|
||||
3. Scroll to the bottom and click on **API & Webhooks**
|
||||
4. Click the blue **Generate new token** button and type in anything you'd like as the app name
|
||||
5. Press **Copy token** and then paste it into the Cal.com importer
|
||||
<Callout>
|
||||
Even though we don't store your access token, you can press **Revoke** to destroy the access token from the **API & Webhooks** page once the import is complete.
|
||||
</Callout>
|
||||
|
||||
## SavvyCal
|
||||
The following steps will help you retrieve your SavvyCal access token, which you will need to present at the import screen of the onboarding process.
|
||||
1. Head to the SavvyCal website and click **Settings** in the sidebar
|
||||
2. Click the **Developers** tab, and under **Personal access tokens**, click the blue **Create a token** link
|
||||
3. Give the token any name you'd like, and then confirm
|
||||
4. Click to copy the token, and then paste the token into the Cal.com importer
|
||||
<Callout>
|
||||
Even though we don't store your access token, you can press the trash icon to revoke the access token from the **Developers** tab once the import is complete.
|
||||
</Callout>
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
title: Home
|
||||
---
|
||||
|
||||
import Bleed from "nextra-theme-docs/bleed";
|
||||
|
||||
# Cal.com Documentation
|
||||
|
||||
Welcome to our product documentation, where you can explore advice and explanations for all of our features, as well as discover new tips and tricks to get the most out of your subscription.
|
||||
|
||||
This is also the home of our design system documentation and developer docs.
|
||||
|
||||
If you don't already know what Cal.com is about, please head over to [our website](https://cal.com), where you can learn more about the product before venturing into the documentation.
|
||||
|
||||
Want to help make these docs even better? This site is fully open source, and the source code is available on [GitHub](https://github.com/calcom/cal.com/tree/main/apps/docs). You can also click the edit button at the bottom of any page to start editing the source code and start a pull request.
|
||||
|
||||
<Bleed></Bleed>
|
||||
|
|
@ -1,262 +0,0 @@
|
|||
---
|
||||
title: Embed
|
||||
---
|
||||
|
||||
import Anchor from "../../components/Anchor"
|
||||
|
||||
# Embed
|
||||
|
||||
The Embed allows your website visitors to book a meeting with you directly from your website.
|
||||
|
||||
## Install on any website
|
||||
|
||||
Install the following Vanilla JS Snippet to get embed to work on any website. After that you can <a href="#popular-ways-in-which-you-can-embed-on-your-website">choose any of the ways</a> to show your Cal Link embedded on your website.
|
||||
|
||||
```html
|
||||
<script>
|
||||
(function (C, A, L) {
|
||||
let p = function (a, ar) {
|
||||
a.q.push(ar);
|
||||
};
|
||||
let d = C.document;
|
||||
C.Cal =
|
||||
C.Cal ||
|
||||
function () {
|
||||
let cal = C.Cal;
|
||||
let ar = arguments;
|
||||
if (!cal.loaded) {
|
||||
cal.ns = {};
|
||||
cal.q = cal.q || [];
|
||||
d.head.appendChild(d.createElement("script")).src = A;
|
||||
cal.loaded = true;
|
||||
}
|
||||
if (ar[0] === L) {
|
||||
const api = function () {
|
||||
p(api, arguments);
|
||||
};
|
||||
const namespace = ar[1];
|
||||
api.q = api.q || [];
|
||||
typeof namespace === "string" ? (cal.ns[namespace] = api) && p(api, ar) : p(cal, ar);
|
||||
return;
|
||||
}
|
||||
p(cal, ar);
|
||||
};
|
||||
})(window, "https://cal.com/embed.js", "init");
|
||||
Cal("init")
|
||||
</script>
|
||||
```
|
||||
|
||||
## Install with a Framework
|
||||
|
||||
### embed-react
|
||||
|
||||
It provides a react component `<Cal>` that can be used to show the embed inline at that place.
|
||||
|
||||
```bash
|
||||
yarn add @calcom/embed-react
|
||||
```
|
||||
|
||||
### Any XYZ Framework
|
||||
|
||||
You can use Vanilla JS Snippet to install
|
||||
|
||||
<Anchor as="H2">Popular ways in which you can embed on your website</Anchor>
|
||||
|
||||
Assuming that you have followed the steps of installing and initializing the snippet, you can show the embed in following ways:
|
||||
|
||||
### Inline
|
||||
|
||||
Show the embed inline inside a container element. It would take the width and height of the container element.
|
||||
|
||||
<details>
|
||||
<summary>_Vanilla JS_</summary>
|
||||
|
||||
```html
|
||||
<script>
|
||||
Cal("inline", {
|
||||
elementOrSelector: "Your Embed Container Selector Path", // You can also provide an element directly
|
||||
calLink: "jane", // The link that you want to embed. It would open https://cal.com/jane in embed
|
||||
config: {
|
||||
name: "John Doe", // Prefill Name
|
||||
email: "johndoe@gmail.com", // Prefill Email
|
||||
notes: "Test Meeting", // Prefill Notes
|
||||
guests: ["janedoe@gmail.com", "test@gmail.com"], // Prefill Guests
|
||||
theme: "dark", // "dark" or "light" theme
|
||||
},
|
||||
});
|
||||
</script>
|
||||
|
||||
*Sample sandbox*
|
||||
```
|
||||
<iframe src="https://codesandbox.io/embed/vanilla-js-inline-embed-r27n67?fontsize=14&hidenavigation=1&theme=dark"
|
||||
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
|
||||
title="Cal Component - Embed Inline Demo[React][TypeScript]"
|
||||
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
|
||||
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
|
||||
></iframe>
|
||||
</details>
|
||||
|
||||
####
|
||||
|
||||
<details>
|
||||
<summary>_React_</summary>
|
||||
|
||||
```jsx
|
||||
import Cal from "@calcom/embed-react";
|
||||
|
||||
const MyComponent = () => (
|
||||
<Cal
|
||||
calLink="pro"
|
||||
config={{
|
||||
name: "John Doe",
|
||||
email: "johndoe@gmail.com",
|
||||
notes: "Test Meeting",
|
||||
guests: ["janedoe@gmail.com"],
|
||||
theme: "dark",
|
||||
}}
|
||||
/>
|
||||
);
|
||||
```
|
||||
|
||||
*Sample sandbox*
|
||||
|
||||
<iframe src="https://codesandbox.io/embed/cal-component-embed-inline-demo-react-typescript-d1zlcn?fontsize=14&hidenavigation=1&theme=dark"
|
||||
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
|
||||
title="Cal Component - Embed Inline Demo[React][TypeScript]"
|
||||
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
|
||||
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
|
||||
></iframe>
|
||||
</details>
|
||||
|
||||
### Popup on any existing element
|
||||
|
||||
To show the embed as a popup on clicking an element, add `data-cal-link` attribute to the element.
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Vanilla JS</summary>
|
||||
|
||||
To show the embed as a popup on clicking an element, simply add `data-cal-link` attribute to the element.
|
||||
|
||||
*Sample sandbox*
|
||||
<iframe src="https://codesandbox.io/embed/popup-on-click-of-an-existing-element-y9lcuo?fontsize=14&hidenavigation=1&theme=dark"
|
||||
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
|
||||
title="Cal Component - Embed Inline Demo[React][TypeScript]"
|
||||
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
|
||||
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
|
||||
></iframe>
|
||||
|
||||
<button data-cal-link="jane" data-cal-config="A valid config JSON"></button>
|
||||
</details>
|
||||
<details>
|
||||
<summary>React</summary>
|
||||
```jsx
|
||||
import "@calcom/embed-react";
|
||||
|
||||
const MyComponent = ()=> {
|
||||
return <button data-cal-link="jane" data-cal-config='A valid config JSON'></button>
|
||||
}
|
||||
```
|
||||
|
||||
*Sample sandbox*
|
||||
<iframe src="https://codesandbox.io/embed/embed-popup-on-click-of-an-existing-element-demo-react-sc967e?fontsize=14&hidenavigation=1&theme=dark"
|
||||
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
|
||||
title="Cal Component - Embed Inline Demo[React][TypeScript]"
|
||||
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
|
||||
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
|
||||
></iframe>
|
||||
|
||||
</details>
|
||||
|
||||
### Floating pop-up button
|
||||
|
||||
```html
|
||||
<script>
|
||||
Cal("floatingButton", {
|
||||
// The link that you want to embed. It would open https://cal.com/jane in embed
|
||||
calLink: "jane",
|
||||
});
|
||||
</script>
|
||||
```
|
||||
|
||||
*Sample sandbox*
|
||||
<iframe src="https://codesandbox.io/embed/embed-floating-button-popup-all-websites-cg7pru?fontsize=14&hidenavigation=1&theme=dark"
|
||||
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
|
||||
title="Cal Component - Embed Inline Demo[React][TypeScript]"
|
||||
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
|
||||
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
|
||||
></iframe>
|
||||
|
||||
## Supported Instructions
|
||||
|
||||
Consider an instruction as a function with that name and that would be called with the given arguments.
|
||||
|
||||
### `inline`
|
||||
|
||||
Appends embed inline as the child of the element.
|
||||
|
||||
```html
|
||||
<script>
|
||||
Cal("inline", { elementOrSelector, calLink });
|
||||
</script>
|
||||
````
|
||||
|
||||
- `elementOrSelector` - Give it either a valid CSS selector or an HTMLElement instance directly
|
||||
|
||||
- `calLink` - Cal Link that you want to embed e.g. john. Just give the username. No need to give the full URL [https://cal.com/john](). It makes it easy to configure the calendar host once and use as many links you want with just usernames
|
||||
|
||||
### `ui`
|
||||
|
||||
Configure UI for embed. Make it look part of your webpage.
|
||||
|
||||
```html
|
||||
<script>
|
||||
Cal("inline", { styles });
|
||||
</script>
|
||||
```
|
||||
|
||||
- `styles` - It supports styling for `body` and `eventTypeListItem`. Right now we support just background on these two.
|
||||
|
||||
### preload
|
||||
|
||||
Usage:
|
||||
|
||||
If you want to open cal link on some action. Make it pop open instantly by preloading it.
|
||||
|
||||
```html
|
||||
<script>
|
||||
Cal("preload", { calLink });
|
||||
</script>
|
||||
```
|
||||
|
||||
- `calLink` - Cal Link that you want to embed e.g. john. Just give the username. No need to give the full URL [https://cal.com/john]()
|
||||
|
||||
## Actions
|
||||
You can listen to an action that occurs in embedded cal link as follows. You can think of them as DOM events. We are avoiding the term "events" to not confuse it with Cal Events.
|
||||
```html
|
||||
<script>
|
||||
Cal("on", {
|
||||
action: "ANY_ACTION_NAME",
|
||||
callback: (e)=>{
|
||||
// `data` is properties for the event.
|
||||
// `type` is the name of the action(You can also call it type of the action.) This would be same as "ANY_ACTION_NAME" except when ANY_ACTION_NAME="*" which listens to all the events.
|
||||
// `namespace` tells you the Cal namespace for which the event is fired/
|
||||
const {data, type, namespace} = e.detail;
|
||||
}
|
||||
})
|
||||
</script>
|
||||
```
|
||||
|
||||
Following are the list of supported actions.
|
||||
-
|
||||
| Action | Description | Properties |
|
||||
|----------------------|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| eventTypeSelected | When user chooses an event-type from the listing. | eventType:object // Event Type that has been selected" |
|
||||
| bookingSuccessful | When the booking is successfully done. It might not be confirmed. | confirmed: boolean; //Whether confirmation from organizer is pending or not <br/><br/>eventType: "Object for Event Type that has been booked"; <br/><br/>date: string; // Date of Event <br/><br/>duration: number; //Duration of booked Event <br/><br/>organizer: object //Organizer details like name, timezone, email |
|
||||
| linkReady | Tells that the link is ready to be shown now. | None |
|
||||
| linkFailed | Fired if link fails to load | code: number; // Error Code <br/><br/>msg: string; //Human Readable msg <br/><br/>data: object // More details to debug the error |
|
||||
| __iframeReady | It is fired when the embedded iframe is ready to communicate with parent snippet. This is mostly for internal use by Embed Snippet | None |
|
||||
| __windowLoadComplete | Tells that window load for iframe is complete | None |
|
||||
| __dimensionChanged | Tells that dimensions of the content inside the iframe changed. | iframeWidth:number, iframeHeight:number |
|
||||
|
||||
_Actions that start with __ are internal._
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: Google
|
||||
---
|
||||
|
||||
# Google Calendar
|
||||
The Google Calendar integration checks for availability in your Google Calendars and creates bookings for you.
|
||||
|
||||
## Removing Permissions for Cal to access your Google Account
|
||||
|
||||
1. Go to your [Google Account](https://myaccount.google.com/).
|
||||
2. On the left, click Data & privacy.
|
||||
3. Scroll to "Data from apps and services you use."
|
||||
4. Under "Download or delete your data," click Delete a Google service. You may need to sign in again.
|
||||
5. Next to the product you want to remove, click Delete.
|
||||
6. Follow the steps on the screen.
|
||||
|
||||
To remove a product from your account that isn't listed in your Google Account, visit [Google Support](https://support.google.com) for more info on a specific product.
|
||||
|
||||
## Obtaining the Google API Credentials
|
||||
1. Open [Google API Console](https://console.cloud.google.com/apis/dashboard). If you don't have a project in your Google Cloud subscription, you'll need to create one before proceeding further. Under Dashboard pane, select Enable APIS and Services.
|
||||
2. In the search box, type calendar and select the Google Calendar API search result.
|
||||
3. Enable the selected API.
|
||||
4. Next, go to the [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) from the side pane. Select the app type (Internal or External) and enter the basic app details on the first page.
|
||||
5. In the second page on Scopes, select Add or Remove Scopes. Search for Calendar.event and select the scope with scope value `.../auth/calendar.events`, `.../auth/calendar.readonly`, `.../auth/calendar` and select Update.
|
||||
6. In the third page (Test Users), add the Google account(s) you'll using. Make sure the details are correct on the last page of the wizard and your consent screen will be configured.
|
||||
7. Now select [Credentials](https://console.cloud.google.com/apis/credentials) from the side pane and then select Create Credentials. Select the OAuth Client ID option.
|
||||
8. Select Web Application as the Application Type.
|
||||
9. Under Authorized redirect URI's, select Add URI and then add the two URIs `<CALENDSO URL>/api/integrations/googlecalendar/callback` and `<CALENDSO URL>/api/auth/callback/google` replacing CALENDSO URL with the URI at which your application runs.
|
||||
10. The key will be created and you will be redirected back to the Credentials page. Select the newly generated client ID under OAuth 2.0 Client IDs.
|
||||
11. Select Download JSON. Copy the contents of this file and paste the entire JSON string in the .env file as the value for GOOGLE_API_CREDENTIALS key.
|
||||
|
||||
## Where to find the Google Meet integration?
|
||||
|
||||
Google Meet is a part of the Google Calendar integration and it should be available once you've added your Google Calendar. Just select Google Meet as location for your Event Type:
|
||||
|
||||
1. Go to your `Event Types`.
|
||||
2. Click on the `Location` drop-down menu.
|
||||
3. Select Google Meet as the location of your meeting.
|
||||
|
||||
Once your Event Type slot is booked, it will automatically generate the Google Meet link for the meeting.
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
# Integrations
|
||||
|
||||
## Connecting new calendars
|
||||
1. Go to the [Cal App Store](https://app.cal.com/apps).
|
||||
2. Located at the top right of the screen, press the button saying '+ Connect A New App'
|
||||
3. Choose the account your calendar is connected too by clicking 'Add'. (e.g. Google, Office 365, Zoom)
|
||||
4. You will be redirected to the log in page of the chosen account.
|
||||
5. Allow Cal access to view and edit your calendars.
|
||||
6. You will be sent back to the [Cal App Store](https://app.cal.com/apps/installed). From here you will now be able to see your connected calendar!
|
||||
|
||||
## How to choose the primary Calendar?
|
||||
|
||||
If you have two or more integrated calendars and you want your events to show in only one, you can define a primary calendar like this:
|
||||
|
||||
1. Go to your [Installed](https://app.cal.com/apps/installed) page.
|
||||
2. Next to your `Calendars` you will see a dropdown that says `Create events on:`.
|
||||
3. Select your primary calendar.
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
{
|
||||
"introduction": "Introduction",
|
||||
"google": "Google",
|
||||
"microsoft": "Microsoft",
|
||||
"zoom": "Zoom",
|
||||
"stripe": "Stripe",
|
||||
"zapier": "Zapier"
|
||||
}
|
||||
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
title: Microsoft
|
||||
---
|
||||
|
||||
# Outlook/Microsoft 365
|
||||
The Outlook integration enables you to use your outlook.com or Microsoft 365 account to use for conflict checking and event bookings.
|
||||
|
||||
## Obtaining Microsoft Graph Client ID and Secret
|
||||
1. Open [Azure App Registration](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps) and select New registration
|
||||
2. Name your application
|
||||
3. Set **Who can use this application or access this API?** to **Accounts in any organizational directory (Any Azure AD directory - Multitenant)**
|
||||
4. Set the **Web** redirect URI to `<CALENDSO URL>/api/integrations/office365calendar/callback` replacing CALENDSO URL with the URI at which your application runs.
|
||||
5. Use **Application (client) ID** as the **MS_GRAPH_CLIENT_ID** attribute value in .env
|
||||
6. Click **Certificates & secrets** create a new client secret and use the value as the **MS_GRAPH_CLIENT_SECRET** attribute
|
||||
|
||||
## Removing Permissions for Cal to access your Microsoft Workplace Account
|
||||
|
||||
Hover over Cal.com in the my apps portal, then select `manage your application`.
|
||||
|
||||
The top part of permissions window shows what you personally consented to. Examples of apps permissions include the ability to access your calendar, contacts, or camera.
|
||||
|
||||
You can revoke any of the permissions you consented to by selecting `Revoke Permissions`, however removing a permission may break some of the apps functionality. If you have problems after you remove permissions or accounts, contact your organization's Helpdesk for additional assistance.
|
||||
|
||||
If you require more help, head over the Microsoft Documentation Page about [Managing Applications](https://docs.microsoft.com/en-us/azure/active-directory/user-help/my-applications-portal-permissions-saved-accounts)
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
Title: Slack
|
||||
---
|
||||
|
||||
# Slack
|
||||
|
||||
## Connecting
|
||||
Connecting the bot is easy - If you are a workspace admin, the install button will add the bot to the workspace and also authorize your account with the bot. If you are a normal user, the install button will connect your Slack account with Cal.com. This will allow you to perform commands in Slack.
|
||||
|
||||
## Commands
|
||||
`/today` - This command will display all meetings you have in your Cal.com profile for the current day. This will send a hidden message (not visible to anyone other than you) to the channel you issued the command in.
|
||||
|
||||
`/create-event` - It will display a modal allowing you to simply create a meeting invite with anyone in Slack. Success/Error information will be displayed in a private direct message from the bot.
|
||||
|
||||
`/links` - This command will post all your Cal.com meeting links into the current Slack channel you are in. **Note**: The bot needs to have permission to talk in the channel you are sending the message in. Otherwise, you won't be able to send your links.
|
||||
|
||||
As this is the beggining stage of our Slack integration, we plan on adding more commands in the future that will further improve your Cal.com experience.
|
||||
|
||||
## Self-Hosted
|
||||
If you are using our self-hosted version, please refer to our documentation in
|
||||
[cal.com/README.md](https://github.com/calcom/cal.com/blob/main/README.md#obtaining-slack-client-id-and-secret-and-signing-secret)
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
title: Stripe
|
||||
---
|
||||
|
||||
# Stripe Payments
|
||||
|
||||
The Stripe integration allows users to add payments to their bookings.
|
||||
|
||||
## Adding the stripe integration
|
||||
|
||||
1. Go to the [Cal App Store](https://app.cal.com/integrations).
|
||||
2. Located near the top of this page will be the integration 'Stripe' and located to the right will be a button called 'Connect', press this.
|
||||
3. You will be redirected to Stripe requesting for Cal.com to be authorized access. Press 'Accept'.
|
||||
|
||||
This stripe integration has now successfully been added.
|
||||
|
||||
## Removing the stripe integration
|
||||
|
||||
1. Go to the [Cal App Store](https://app.cal.com/integrations).
|
||||
2. Located near the top of this page will be the integration 'Stripe' and located to the right will be a button called 'Disconnect', press this.
|
||||
3. A confirmation pop up box will appear, to confirm press the button saying 'Yes, disconnect integration'.
|
||||
|
||||
This stripe integration has now successfully been disconnected.
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
title: Zapier
|
||||
---
|
||||
|
||||
## Do you have a Zapier integration?
|
||||
|
||||
We are currently working on it, but it isn’t live just yet. Until then, you can use our Webhooks integration and use Zapier's “Webhooks by Zapier”.
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
---
|
||||
title: Zoom
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Zoom
|
||||
|
||||
The Zoom integration automatically creates Zoom meetings for your bookings.
|
||||
|
||||
## Connecting your Zoom account
|
||||
|
||||
1. Go to the App Store page, and click the 'Add new integration' button.
|
||||
2. Next to Zoom, go ahead and click the 'Add' button.
|
||||
3. You will now be taken to Zoom to sign into your account and authorize Cal.
|
||||
|
||||
## Disconnecting your Zoom account
|
||||
|
||||
1. Go to the App Store page, and click on your Zoom integration in the list.
|
||||
2. On the right hand side, click the Delete App button.
|
||||
|
||||
This will remove the integration from Cal. Cal will not perform any actions on your account once the integration is removed. However, if you want to revoke Cal's permissions from your Zoom account, perform the following steps:
|
||||
|
||||
1. Log into your Zoom account and navigate to the App Marketplace
|
||||
2. Click Manage > Installed Apps or search for the Cal app
|
||||
3. Click on the Cal app
|
||||
4. Click Uninstall
|
||||
|
||||
## How we interact with your Zoom account
|
||||
|
||||
We only need the ability to create meetings, so when somebody books an event with you, Cal can communicate with Zoom and create the corresponding meeting.
|
||||
|
||||
## Setting up Zoom on your self-hosted instance
|
||||
|
||||
1. Open [Zoom Marketplace](https://marketplace.zoom.us/) and sign in with your Zoom account.
|
||||
2. On the upper right, click "Develop" => "Build App".
|
||||
3. On "OAuth", select "Create".
|
||||
4. Name your App.
|
||||
5. Choose "User-managed app" as the app type.
|
||||
6. De-select the option to publish the app on the Zoom App Marketplace.
|
||||
7. Click "Create".
|
||||
8. Now copy the Client ID and Client Secret to your .env file into the `ZOOM_CLIENT_ID` and `ZOOM_CLIENT_SECRET` fields.
|
||||
9. Set the Redirect URL for OAuth `<CALENDSO URL>/api/integrations/zoomvideo/callback` replacing CALENDSO URL with the URI at which your application runs.
|
||||
10. Also add the redirect URL given above as an allowlist URL and enable "Subdomain check". Make sure it says "saved" below the form.
|
||||
11. You don't need to provide basic information about your app. Instead click at "Scopes" and then at "+ Add Scopes". On the left, click the category "Meeting" and check the scope `meeting:write`.
|
||||
12. Click "Done".
|
||||
13. You're good to go. Now you can easily add your Zoom integration in the Cal settings.
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
{
|
||||
"index": "Home",
|
||||
"self-hosting": "Self-hosting",
|
||||
"availability": "Availability",
|
||||
"bookings": "Bookings",
|
||||
"event-types": "Event Types",
|
||||
"teams": "Teams",
|
||||
"integrations": "Integrations",
|
||||
"public-api": "API",
|
||||
"webhooks": "Webhooks",
|
||||
"settings": "Settings",
|
||||
"import": "Import",
|
||||
"billing": "Billing",
|
||||
"developer": "Developer",
|
||||
"contributing": "Contributing",
|
||||
"faq": "FAQs"
|
||||
}
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
import Bleed from 'nextra-theme-docs/bleed'
|
||||
import Head from "next/head";
|
||||
import IframeResizer from "iframe-resizer-react";
|
||||
import {useWindowSize} from "../lib/useWindowSize";
|
||||
|
||||
|
||||
<Bleed full>
|
||||
<Head><title>Public API | Cal.com</title></Head>
|
||||
<IframeResizer
|
||||
autoResize
|
||||
src={process.env.NEXT_PUBLIC_SWAGGER_DOCS_URL || "https://developer.cal.com"}
|
||||
frameBorder="0"
|
||||
style={{
|
||||
width: useWindowSize().width > 768 ? "calc(100vw - 16rem)": "100vw",
|
||||
minHeight: useWindowSize().width > 768 ? "100vh" : "200vh",
|
||||
height: "auto",
|
||||
border: 0,
|
||||
}}
|
||||
/>
|
||||
</Bleed>
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
---
|
||||
title: Docker
|
||||
---
|
||||
|
||||
# Docker
|
||||
|
||||
The Docker configuration for Cal is an effort powered by people within the community. Cal does not provide official support for Docker, but we will accept fixes and documentation. Use at your own risk.
|
||||
|
||||
The Docker configuration can be found [in our docker repository](https://github.com/calcom/docker).
|
||||
|
||||
## Requirements
|
||||
|
||||
Make sure you have `docker` & `docker-compose` installed on the server / system.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Option #1: Docker Hub
|
||||
|
||||
```bash
|
||||
docker pull calendso/calendso
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
### Option #2: Cloning
|
||||
|
||||
1. Clone calendso-docker
|
||||
|
||||
```bash
|
||||
git clone --recursive https://github.com/calendso/docker.git calendso-docker
|
||||
```
|
||||
|
||||
2. Update `.env` if needed
|
||||
|
||||
3. Build and start calendso
|
||||
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
4. Start prisma studio
|
||||
```bash
|
||||
docker-compose exec calendso npx prisma studio
|
||||
```
|
||||
5. Open a browser to [port 5555](http://localhost:5555) on your localhost to look at or modify the database content.
|
||||
|
||||
6. Click on the `User` model to add a new user record.
|
||||
7. Fill out the fields (remembering to encrypt your password with [BCrypt](https://bcrypt-generator.com/)) and click `Save 1 Record` to create your first user.
|
||||
8. Open a browser to [port 3000](http://localhost:3000) on your localhost and login with your just created, first user.
|
||||
|
|
@ -1,128 +0,0 @@
|
|||
---
|
||||
title: Installation
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
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.
|
||||
|
||||
- Node.js
|
||||
- PostgreSQL
|
||||
- Yarn _(recommended)_
|
||||
|
||||
> 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 category.
|
||||
|
||||
## Setup
|
||||
|
||||
1. Clone the repo
|
||||
|
||||
```sh
|
||||
git clone https://github.com/calcom/cal.com.git
|
||||
```
|
||||
|
||||
1. Go to the project folder
|
||||
|
||||
```sh
|
||||
cd cal.com
|
||||
```
|
||||
|
||||
1. Copy `.env.example` to `.env`
|
||||
|
||||
```sh
|
||||
cp apps/web/.env.example apps/web/.env
|
||||
```
|
||||
|
||||
1. Install packages with yarn
|
||||
|
||||
```sh
|
||||
yarn
|
||||
```
|
||||
|
||||
### 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
|
||||
|
||||
```sh
|
||||
yarn dx
|
||||
```
|
||||
|
||||
### Manual setup
|
||||
|
||||
1. Configure database in the `.env` file. Replace `<user>`, `<pass>`, `<db-host>`, `<db-port>` with their applicable values
|
||||
|
||||
```text
|
||||
DATABASE_URL='postgresql://<user>:<pass>@<db-host>:<db-port>'
|
||||
```
|
||||
|
||||
<details>
|
||||
|
||||
<summary>
|
||||
If you don't know how to configure the DATABASE_URL, then follow the steps here to create a quick DB
|
||||
using Heroku
|
||||
</summary>
|
||||
|
||||
1. Create a free account with [Heroku](https://www.heroku.com/).
|
||||
|
||||
2. Create a new app.
|
||||
|
||||
<img
|
||||
width="306"
|
||||
alt="Create an App"
|
||||
src="https://user-images.githubusercontent.com/16905768/115322780-b3d58c00-a17e-11eb-8a52-b758fb0ea942.png"
|
||||
/>
|
||||
|
||||
3. In your new app, go to `Overview` and next to `Installed add-ons`, click `Configure Add-ons`. We need this to set up our database.
|
||||
|
||||
|
||||
4. Once you clicked on `Configure Add-ons`, click on `Find more add-ons` and search for `postgres`. One of the options will be `Heroku Postgres` - click on that option.
|
||||
|
||||
|
||||
5. Once the pop-up appears, click `Submit Order Form` - plan name should be `Hobby Dev - Free`.
|
||||
|
||||
<img
|
||||
width="512"
|
||||
alt="Submit Order Form"
|
||||
src="https://user-images.githubusercontent.com/16905768/115323265-b4baed80-a17f-11eb-99f0-d67f019aa6df.png"
|
||||
/>
|
||||
|
||||
6. Once you completed the above steps, click on your newly created `Heroku Postgres` and go to its `Settings`.
|
||||
|
||||
|
||||
7. In `Settings`, copy your URI to your Cal.com .env file and replace the `postgresql://<user>:<pass>@<db-host>:<db-port>` with it.
|
||||
|
||||
|
||||
|
||||
8. To view your DB, once you add new data in Prisma, you can use [Heroku Data Explorer](https://heroku-data-explorer.herokuapp.com/).
|
||||
|
||||
</details>
|
||||
|
||||
1. Set a 32 character random string in your `apps/web/.env` file for the `CALENDSO_ENCRYPTION_KEY` (You can use a command like `openssl rand -base64 24` to generate one).
|
||||
1. Set up the database using the Prisma schema (found in `packages/prisma/schema.prisma`)
|
||||
|
||||
```sh
|
||||
yarn workspace @calcom/prisma db-deploy
|
||||
```
|
||||
|
||||
1. Run (in development mode)
|
||||
|
||||
```sh
|
||||
yarn dev
|
||||
```
|
||||
|
||||
### Setting up your first user
|
||||
|
||||
1. Open [Prisma Studio](https://www.prisma.io/studio) to look at or modify the database content:
|
||||
|
||||
```sh
|
||||
yarn db-studio
|
||||
```
|
||||
|
||||
1. Click on the `User` model to add a new user record.
|
||||
1. Fill out the fields `email`, `username`, `password`, and set `metadata` to empty `{}` (remembering to encrypt your password with [BCrypt](https://bcrypt-generator.com/)) 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 the `prisma/schema.prisma` file.
|
||||
1. Open a browser to [port 3000](http://localhost:3000) and login with your just created, first user.
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
{
|
||||
"install": "Installation",
|
||||
"upgrade": "Upgrade",
|
||||
"docker": "Docker",
|
||||
"vercel": "Vercel"
|
||||
}
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
---
|
||||
title: Upgrade
|
||||
---
|
||||
|
||||
# Upgrading
|
||||
|
||||
**Warning**: When performing database migrations, you may lose data if the migration is not done properly.
|
||||
|
||||
1. Pull the current version:
|
||||
```sh
|
||||
git pull
|
||||
```
|
||||
2. Apply database migrations by running <b>one of</b> the following commands:
|
||||
|
||||
In a development environment, run:
|
||||
|
||||
```sh
|
||||
yarn workspace @calcom/prisma db-migrate
|
||||
```
|
||||
|
||||
(this can clear your development database in some cases)
|
||||
|
||||
In a production environment, run:
|
||||
|
||||
```sh
|
||||
yarn workspace @calcom/prisma db-deploy
|
||||
```
|
||||
|
||||
3. Check the `.env.example` and compare it to your current `.env` file. In case there are any fields not present
|
||||
in your current `.env`, add them there.
|
||||
|
||||
For the current version, especially check if the variable `BASE_URL` is present and properly set in your environment, for example:
|
||||
|
||||
```text
|
||||
BASE_URL='https://yourdomain.com'
|
||||
```
|
||||
|
||||
4. Start the server. In a development environment, just do:
|
||||
```sh
|
||||
yarn dev
|
||||
```
|
||||
For a production build, run for example:
|
||||
```sh
|
||||
yarn build
|
||||
yarn start
|
||||
```
|
||||
5. Enjoy the new version.
|
||||
|
|
@ -1,50 +0,0 @@
|
|||
---
|
||||
title: Vercel
|
||||
---
|
||||
|
||||
# Vercel
|
||||
|
||||
## Requirements
|
||||
|
||||
You need a PostgresDB database hosted somewhere. [Supabase](https://supabase.com/) offers a great free option.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Local settings
|
||||
|
||||
1. Fork and clone the repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/<your-fork>/cal.com.git
|
||||
```
|
||||
|
||||
2. Copy the `.env.example` file in `apps/web`, rename it to `.env` and fill it with your settings ([See manual setup](https://github.com/calcom/cal.com#manual-setup) and [Obtaining the Google API Credentials](https://github.com/calcom/cal.com#obtaining-the-google-api-credentials))
|
||||
|
||||
3. Install packages with `yarn`
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
4. Set up the database using the Prisma schema (found in `packages/prisma/schema.prisma`)
|
||||
|
||||
```sh
|
||||
yarn workspace @calcom/prisma db-deploy
|
||||
```
|
||||
|
||||
5. Open [Prisma Studio](https://www.prisma.io/studio) to look at or modify the database content:
|
||||
```
|
||||
yarn db-studio
|
||||
```
|
||||
6. Click on the `User` model to add a new user record.
|
||||
7. Fill out the fields (remembering to encrypt your password with [BCrypt](https://bcrypt-generator.com/)) and click `Save 1 Record` to create your first user.
|
||||
8. Open a browser to [port 3000](http://localhost:3000) on your localhost and login with your just created, first user.
|
||||
|
||||
### Deployment
|
||||
|
||||
1. Create a new project on Vercel
|
||||
1. Import from your forked repository
|
||||
1. Set the Environment Variables
|
||||
1. Set the root directory to `apps/web`
|
||||
1. Override the build command to `cd ../.. && yarn build`
|
||||
1. Hit Deploy
|
||||
|
|
@ -1,56 +0,0 @@
|
|||
---
|
||||
title: Settings
|
||||
---
|
||||
|
||||
# Settings
|
||||
## Setting up or making changes to your Profile
|
||||
|
||||
1. Go to your [Profile Settings](https://app.cal.com/settings/profile).
|
||||
2. From this page you are able to edit the following:
|
||||
- Your URL Username
|
||||
- Your Display Name
|
||||
- Your About Information
|
||||
- Change your Profile Picture
|
||||
- Your Local Time Zone
|
||||
- Your Chosen 'First Day Of The Week'
|
||||
- Light or Dark Mode for your Booking Page
|
||||
- Enabling or Disabling cal.com Branding on your Booking Page
|
||||
3. Once you have completed all your changes, press that 'save' button located at the bottom right of your page.
|
||||
|
||||
## Reset your password
|
||||
|
||||
1. Go to [your account security settings](https://app.cal.com/settings/security).
|
||||
2. Located at the top of your screen, you will see two boxes.
|
||||
3. Enter your Old Password and New Password.
|
||||
4. Click the button 'Save' located to the bottom right of your new password.
|
||||
5. You have now successfully changed your password!
|
||||
|
||||
## Change your email
|
||||
|
||||
Go to [Profile Settings](https://app.cal.com/settings/profile). There, you will see the email associated with your account which you can then update. You’d just need to log out and back in to see the change take effect.
|
||||
|
||||
## Enable 2FA
|
||||
|
||||
1. Go to [Your Account Security Settings](https://app.cal.com/settings/security).
|
||||
2. Located at the bottom of your screen, click on the tab labeled 'Enable Two-Factor Authentication'.
|
||||
3. Enter your Password.
|
||||
4. In your authenticator app, scan the QR Code presented on your screen.
|
||||
5. Once Scanned, press 'Next' and then enter the code presented within your Authentication App
|
||||
6. Press 'Enabled'
|
||||
|
||||
You have now successfully enabled Two-Factor Authentication
|
||||
|
||||
## Disable 2FA
|
||||
1. Go to [Your Account Security Settings](https://app.cal.com/settings/security).
|
||||
2. Located at the bottom of your screen, click on the tab labeled 'Disable Two-Factor Authentication'.
|
||||
3. Enter your Password.
|
||||
|
||||
You have now successfully disabled Two-Factor Authentication
|
||||
|
||||
## How to delete my account
|
||||
|
||||
You can delete your account from within the [Settings](https://app.cal.com/settings/profile) option. Just scroll all the way down and click on `Delete Account`.
|
||||
|
||||
## How to change the language
|
||||
|
||||
Go to your [Profile Settings](https://app.cal.com/settings/profile). Under `Language` you will see the dropdown menu and you can use it to select your desired language.
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
@font-face {
|
||||
font-family: 'Cal Sans';
|
||||
src: url("https://cal.com/cal.ttf");
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
font-family: 'Cal Sans';
|
||||
font-weight: normal;
|
||||
letter-spacing: normal;
|
||||
}
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
---
|
||||
title: Teams
|
||||
---
|
||||
|
||||
# Teams
|
||||
|
||||
## How do I create a new team?
|
||||
|
||||
1. Go to [Your Teams Settings](https://app.cal.com/settings/teams).
|
||||
2. Press the button displayed on your screen called '+ New Team'
|
||||
3. Enter the name you wish to call your team.
|
||||
4. After entering the name press the 'Create Team' button located just under your new team name.
|
||||
5. You have now created your new team.
|
||||
|
||||
Creating a team will allow you to create new event types for the team, invite team members and much more!
|
||||
|
||||
## How do I change my teams URL?
|
||||
|
||||
1. Go to [Your Teams Settings](https://app.cal.com/settings/teams) and select the team you wish to edit.
|
||||
2. Located at the top of your teams settings will be a team-url bar, from here you can input your requested teams url.
|
||||
3. Once complete make sure you press 'save' at the bottom of the page.
|
||||
|
||||
## How do I change my teams name?
|
||||
|
||||
1. Go to [Your Teams Settings](https://app.cal.com/settings/teams) and select the team you wish to edit.
|
||||
2. Located in the 2nd row of your teams settings will be a Team Name bar, from here you can input your requested team name.
|
||||
3. Once complete make sure you press 'save' at the bottom of the page.
|
||||
|
||||
## How do I add and remove a description of my team?
|
||||
|
||||
1. Go to [Your Teams Settings](https://app.cal.com/settings/teams) and select the team you wish to edit.
|
||||
2. Located below your team name entry box is a large text box labeled 'About',
|
||||
|
||||
## How do I upload my team logo?
|
||||
|
||||
1. Go to [Your Teams Settings](https://app.cal.com/settings/teams) and select the team you wish to edit.
|
||||
2. Located under your teams subscription will be a box that says 'Upload a logo', press this box.
|
||||
3. Press 'choose a file' and locate a file from your machine you wish to use as your team logo.
|
||||
4. Once complete make sure you press 'save' at the bottom of the page.
|
||||
|
||||
## How do I manage team members?
|
||||
|
||||
1. Go to [Your Teams Settings](https://app.cal.com/settings/teams) and select the team you wish to edit.
|
||||
2. Located at the bottom of your page is your team members, from here you can choose to add or remove team members and even change their role which could be Member, Admin or Owner.
|
||||
|
||||
## How do I delete my team I created?
|
||||
|
||||
1. Go to [Your Teams Settings](https://app.cal.com/settings/teams).
|
||||
2. From here you will be able to see a list of teams you have created or apart of, located to the right of the team you wish to delete you can find three dots (...)
|
||||
3. Press the 3 dots (...) then 'Disband Team'
|
||||
4. This will brin gup a prompt confirming if you wish to disband your team, if your are sure you can press the button labeled 'Yes, disband team'
|
||||
|
||||
Your team has now successfully been deleted.
|
||||
|
||||
## Where can I find my team's Event Types?
|
||||
|
||||
Once you open `Event Types` on your dashboard, you will find your team's Event Types below your individual ones.
|
||||
|
|
@ -1,98 +0,0 @@
|
|||
---
|
||||
title: Webhooks
|
||||
---
|
||||
|
||||
# Webhooks
|
||||
|
||||
## Create a new Webhook
|
||||
|
||||
1. Go to [Your Integrations](https://app.cal.com/integrations).
|
||||
2. Scrolling down to the bottom of the page you will see a button called ‘New Webhook’. Press this button to open up the box which will ask for details on creating the new webhooks.
|
||||
3. Select whatever event this triggers, this may be Create, Cancelled or Reschedule.
|
||||
4. Once this is completed, insert the Subscriber URL then click 'Save' located at the bottom right of the box.
|
||||
|
||||
## Edit an existing Webhook
|
||||
|
||||
1. Go to [Your Integrations](https://app.cal.com/integrations).
|
||||
2. Scrolling down to the bottom of the page you will see an icon to the right of your webhook, this will be labeled edit webhook.
|
||||
3. Press the button and from here you can change any of the webhook settings. This could be changing the event that is triggered and this may be Create, Cancelled or Reschedule. Or you can change the Subscriber URL.
|
||||
|
||||
## Delete an existing Webhook
|
||||
|
||||
1. Go to [Your Integrations](https://app.cal.com/integrations).
|
||||
2. Scrolling down to the bottom of the page you will see an icon to the right of your webhook, this will be labeled delete webhook.
|
||||
3. Press the button and from here your webhook will no longer work and be deleted.
|
||||
|
||||
## Webhook metadata
|
||||
|
||||
Metadata is a way to pass extra information to Cal.com about a booking that is returned through a webhook.
|
||||
|
||||
### Example
|
||||
|
||||
The best way to explain this is with an example. Let's say you're a bank, and people register an account on your website, but you want them to book an onboarding call with your team to get set up. You could send them to your Cal.com booking link as part of your onboarding process, but when the webhook is returned, it may be difficult to match up which user booked a meeting with the user's account in your own database. Hence, you can pass a `user_id` value for instance as a URL parameter, which makes no difference to the booking process, but when the webhook is returned, you will receive the metadata as part of the webhook payload.
|
||||
|
||||
Metadata is passed as a URL parameter on top of your booking link and follows the following syntax:
|
||||
|
||||
```text
|
||||
metadata[key_name]=value
|
||||
```
|
||||
|
||||
For example, if your booking link is `cal.com/rick/quick-chat`, you can pass a user ID of 123 like so:
|
||||
|
||||
```text
|
||||
cal.com/rick/quick-chat?metadata[user_id]=123
|
||||
```
|
||||
|
||||
As a result, the webhook will be returned in this format:
|
||||
|
||||
```text
|
||||
\{ <other event details>, metadata: \{ user_id: 123 \} \}
|
||||
```
|
||||
|
||||
## Custom Webhooks template variable list
|
||||
|
||||
Customizable webhooks are a great way reduce the development effort and in many cases remove the need for a developer to build an additional integration service. Using a custom template you can easily decide what data you receive in your webhook endpoint, manage the payload and setup related workflows accordingly. Here’s a breakdown of the payload that you would receive via an incoming webhook.
|
||||
|
||||
### Webhook structure
|
||||
|
||||
| Variable | Type | Description |
|
||||
| ------------------- | -------- | -------------------------------------------------------------------------------------- |
|
||||
| triggerEvent | String | The name of the trigger event [BOOKING_CREATED, BOOKING_RESHEDULED, BOOKING_CANCELLED] |
|
||||
| createdAt | String | The time of the webhook trigger |
|
||||
| type | String | The event-type slug |
|
||||
| title | String | The event-type name |
|
||||
| startTime | String | The event's start time |
|
||||
| endTime | String | The event's end time |
|
||||
| description? | String | The event's description as described in the event type |
|
||||
| location? | String | Location of the event |
|
||||
| organizer | Person | The organizer of the event |
|
||||
| attendees | Person[] | The event booker & any guests |
|
||||
| uid? | String | The UID of the booking |
|
||||
| resheduleUid? | String | The UID for the rescheduling |
|
||||
| cancellationReason? | String | Reason for cancellation |
|
||||
| rejectionReason? | String | Reason for rejection |
|
||||
| team?.name | String | Name of the team booked |
|
||||
| team?.members | String[] | Members of the team booked |
|
||||
|
||||
### Person structure
|
||||
|
||||
| Variable | Type | Description |
|
||||
| --------------- | ------ | --------------------------------------------------------------------- |
|
||||
| name | String | Name of the individual |
|
||||
| email | String | Email of the individual |
|
||||
| timeZone | String | Timezone of the individual ("America/New_York", "Asia/Kolkata", etc.) |
|
||||
| language.locale | String | Locale of the individual ("en", "fr", etc.) |
|
||||
|
||||
### Example usage of variables for custom template:
|
||||
|
||||
```sh
|
||||
\{
|
||||
|
||||
"content": "A new event has been scheduled",
|
||||
"type": "\{\{type\}\}",
|
||||
"name": "\{\{title\}\}",
|
||||
"organizer": "\{\{organizer.name\}\}",
|
||||
"booker": "\{\{attendees.0.name\}\}"
|
||||
|
||||
\}
|
||||
```
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 4.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.7 KiB |
|
|
@ -1,9 +0,0 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<browserconfig>
|
||||
<msapplication>
|
||||
<tile>
|
||||
<square150x150logo src="/mstile-150x150.png"/>
|
||||
<TileColor>#292929</TileColor>
|
||||
</tile>
|
||||
</msapplication>
|
||||
</browserconfig>
|
||||
Binary file not shown.
Binary file not shown.
|
Before Width: | Height: | Size: 378 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 581 B |
Binary file not shown.
|
Before Width: | Height: | Size: 850 B |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.9 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.9 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.4 KiB |
|
|
@ -1,31 +0,0 @@
|
|||
<?xml version="1.0" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
|
||||
"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
|
||||
<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
|
||||
width="700.000000pt" height="700.000000pt" viewBox="0 0 700.000000 700.000000"
|
||||
preserveAspectRatio="xMidYMid meet">
|
||||
<metadata>
|
||||
Created by potrace 1.14, written by Peter Selinger 2001-2017
|
||||
</metadata>
|
||||
<g transform="translate(0.000000,700.000000) scale(0.100000,-0.100000)"
|
||||
fill="#000000" stroke="none">
|
||||
<path d="M5288 4751 c-3 -14 -2 -2406 1 -2451 1 -14 30 -16 224 -16 l224 0 -1
|
||||
1241 -1 1240 -222 1 c-193 0 -222 -2 -225 -15z"/>
|
||||
<path d="M2099 4706 c-2 -2 -35 -7 -72 -11 -38 -3 -114 -20 -170 -36 -519
|
||||
-153 -856 -609 -860 -1164 -2 -237 33 -398 128 -587 175 -349 490 -583 880
|
||||
-652 81 -15 385 -15 450 -1 257 55 387 120 533 266 45 45 82 85 82 89 0 4 -30
|
||||
35 -67 67 -185 164 -254 223 -261 223 -4 -1 -32 -23 -62 -51 -59 -55 -200
|
||||
-128 -285 -149 -75 -19 -241 -20 -331 -4 -260 49 -479 262 -548 534 -78 306
|
||||
-4 638 184 829 132 134 286 199 486 205 199 7 389 -62 515 -187 l35 -36 30 26
|
||||
c16 13 49 41 73 61 238 197 232 191 216 215 -24 36 -156 160 -209 195 -86 58
|
||||
-227 121 -306 136 -14 3 -50 10 -80 16 -54 11 -352 25 -361 16z"/>
|
||||
<path d="M3870 4079 c-368 -44 -652 -323 -745 -729 -15 -67 -16 -327 -1 -380
|
||||
4 -14 9 -36 12 -49 12 -57 48 -151 86 -221 155 -291 433 -463 748 -463 233 -1
|
||||
402 79 505 236 20 31 38 57 39 57 1 0 2 -54 1 -120 -1 -114 0 -121 20 -125 11
|
||||
-3 112 -4 225 -2 l205 2 1 883 0 882 -226 0 -226 0 1 -130 c1 -71 0 -130 -1
|
||||
-130 -1 0 -13 17 -25 38 -70 114 -193 201 -334 237 -69 17 -204 24 -285 14z
|
||||
m305 -430 c295 -79 439 -430 299 -726 -93 -196 -324 -307 -534 -257 -19 4 -37
|
||||
8 -40 9 -18 2 -81 33 -115 56 -143 97 -216 243 -216 434 -1 298 218 515 501
|
||||
498 36 -2 83 -9 105 -14z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.7 KiB |
|
|
@ -1,19 +0,0 @@
|
|||
{
|
||||
"name": "Cal.com",
|
||||
"short_name": "Cal.com",
|
||||
"icons": [
|
||||
{
|
||||
"src": "/android-chrome-192x192.png",
|
||||
"sizes": "192x192",
|
||||
"type": "image/png"
|
||||
},
|
||||
{
|
||||
"src": "/android-chrome-512x512.png",
|
||||
"sizes": "512x512",
|
||||
"type": "image/png"
|
||||
}
|
||||
],
|
||||
"theme_color": "#292929",
|
||||
"background_color": "#292929",
|
||||
"display": "standalone"
|
||||
}
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
import { SEO_IMG_DEFAULT, DOCS_URL } from "@calcom/lib/constants";
|
||||
|
||||
const themeConfig = {
|
||||
github: "https://github.com/calcom/cal.com",
|
||||
docsRepositoryBase: "https://github.com/calcom/cal.com/blob/main/apps/docs/pages",
|
||||
titleSuffix: " | Cal.com",
|
||||
logo: <h4 className="m-0">Cal.com</h4>,
|
||||
head: (
|
||||
<>
|
||||
<meta name="msapplication-TileColor" content="#ffffff" />
|
||||
<meta name="theme-color" content="#ffffff" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta httpEquiv="Content-Language" content="en" />
|
||||
<meta
|
||||
name="description"
|
||||
content="Explore advice and explanations for all of our features, and discover new tips and tricks to get the most out of your subscription."
|
||||
/>
|
||||
<meta
|
||||
name="og:description"
|
||||
content="Explore advice and explanations for all of our features, and discover new tips and tricks to get the most out of your subscription."
|
||||
/>
|
||||
<meta name="twitter:card" content="summary_large_image" />
|
||||
<meta name="twitter:image" content={SEO_IMG_DEFAULT} />
|
||||
<meta name="twitter:site:domain" content="docs.cal.com" />
|
||||
<meta name="twitter:url" content={DOCS_URL} />
|
||||
<meta name="og:title" content="Cal.com Documentation" />
|
||||
<meta name="og:image" content={SEO_IMG_DEFAULT} />
|
||||
<meta name="apple-mobile-web-app-title" content="Cal.com Docs" />
|
||||
|
||||
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
|
||||
<link rel="manifest" href="/site.webmanifest" />
|
||||
<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#000000" />
|
||||
<meta name="msapplication-TileColor" content="#ff0000" />
|
||||
<meta name="theme-color" content="#ffffff" />
|
||||
</>
|
||||
),
|
||||
search: true,
|
||||
prevLinks: true,
|
||||
nextLinks: true,
|
||||
footer: true,
|
||||
footerEditLink: "Edit this page on GitHub",
|
||||
footerText: <>© {new Date().getFullYear()} Cal.com, Inc. All rights reserved.</>,
|
||||
};
|
||||
|
||||
export default themeConfig;
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
{
|
||||
"extends": "@calcom/tsconfig/nextjs.json",
|
||||
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
|
||||
"exclude": ["node_modules"],
|
||||
"compilerOptions": {
|
||||
"noImplicitAny": false
|
||||
}
|
||||
}
|
||||
|
|
@ -35,9 +35,6 @@
|
|||
"dev:swagger": "turbo run dev --scope=\"@calcom/api\" --scope=\"@calcom/swagger\"",
|
||||
"dev:website": "turbo run dev --scope=\"@calcom/web\" --scope=\"@calcom/website\"",
|
||||
"dev": "turbo run dev --scope=\"@calcom/web\"",
|
||||
"docs-build": "turbo run build --scope=\"@calcom/docs\" --include-dependencies",
|
||||
"docs-dev": "turbo run dev --scope=\"@calcom/docs\"",
|
||||
"docs-start": "turbo run start --scope=\"@calcom/docs\"",
|
||||
"build-storybook": "turbo run build --scope=\"@calcom/storybook\"",
|
||||
"dx": "turbo run dx",
|
||||
"i-dev": "infisical run -- turbo run dev --scope=\"@calcom/web\"",
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user