Our self-hosted instance of cal.com https://cal.pub0.org
 
 
 
 
 
Go to file
Agusti Fernandez b653276836
Merge pull request #48 from calcom/fix/update-readme
2022-04-21 01:47:05 +02:00
.husky feat: adds git hooks and husky for pre-commit linting 2022-03-25 02:18:43 +01:00
apps/api needed for deployment 2022-04-03 19:16:03 +02:00
json-schema re-unify into one route all id ops for teams and users 2022-04-04 00:49:05 +02:00
lib fix verifyapikey, add daabase_url to env.example 2022-04-18 23:24:57 +02:00
pages/api removes credentials endpoint 2022-04-18 23:40:28 +02:00
scripts no commit in website 2022-04-03 19:50:53 +02:00
templates feat: update readme 2022-04-21 01:46:15 +02:00
tests prettier 2022-03-30 14:17:55 +02:00
.env.example fix verifyapikey, add daabase_url to env.example 2022-04-18 23:24:57 +02:00
.eslintrc.js feat all endpoints one id file 2022-04-04 21:39:30 +02:00
.gitignore chore: remove yarn-error from repo, add to .gitignore 2022-03-29 02:47:48 +02:00
.prettierignore mvoe to less files 2022-04-04 02:02:11 +02:00
.prettierrc.js mvoe to less files 2022-04-04 02:02:11 +02:00
README.md feat: update readme 2022-04-21 01:46:15 +02:00
babel.config.js rebase fixing conflicts 2022-03-23 22:22:57 +01:00
jest.config.ts prettier 2022-03-30 14:17:55 +02:00
jest.setup.ts feat: 50% almost code coverage 2022-03-26 05:28:53 +01:00
next-env.d.ts feat: inital commit 2022-03-18 14:42:42 +01:00
next.config.js fix back api to rewrite 2022-04-15 19:09:35 +02:00
package.json remove next-cors 2022-04-15 18:13:21 +02:00
tsconfig.json fix all swagger docs, dont build templates 2022-04-03 17:47:18 +02:00
yarn.lock feat: inital commit 2022-03-18 14:42:42 +01:00

README.md

Cal.com Public API (Enterprise Only)

This will be the new public enterprise-only API

This is the public REST api for cal.com

NextJS + TypeScript

It's a barebones NextJS + TypeScript project leveraging the nextJS API with a pages/api folder.

  • api.cal.com/v1
  • api.cal.com/api/v1

API Endpoint Validation

Zod

The API uses zod library like our main web repo. It validates that either GET query parameters or POST body content's are valid and up to our spec. It gives appropiate errors when parsing result's with schemas.

Next Validations

Next-Validations Docs Next-Validations Repo We also use this useful helper library that let's us wrap our endpoints in a validate HOC that checks the req against our validation schema built out with zod for either query and / or body's requests.

Testing with Jest + node-mocks-http

We aim to provide a fully tested API for our peace of mind, this is accomplished by using jest + node-mocks-http

Next.config.js

Redirects

Since this will only support an API, we redirect the requests to root to the /api folder. We also added a redirect for future-proofing API versioning when we might need it, without having to resort to dirty hacks like a v1/v2 folders with lots of duplicated code, instead we redirect /api/v*/:rest to /api/:rest?version=*