cal.pub0.org/apps/docs/pages/developer/project-structure.mdx

47 lines
1.0 KiB
Plaintext
Raw Normal View History

Migrate docs to mono repo (#1814) * Initial commit Created from https://vercel.com/new * Update config * Homepage * Self-hosting * Integrations * More docs pages * Developer docs * Update billing.mdx * Update install.mdx * Fix install guide * More fixes * Adding CSS guide * Fix capitalisation on Microsoft page * Added delete account update * Added Zapier integration question * Added GMeet integration part * Added Delete Account to Settings * unnecessary question mark * Added a link to Settings * Added stuff in Billing * Added a link to cal.com/signup * Capitalization * Added language change * Added more stuff in Event Types * Added how to change email * Added FAQ page * Spelling mistake * Added a title to FAQ * Added more stuff to Billing * Availability multi-booking * Deleted from Availability added to FAQ * Added to FAQ * Removed the dot * Added stuff to FAQ * Add license warning to adding CSS page * Update docker.mdx * Add import instructions * removed readme until we have our own * updated favicon, added cal sans * added new cal sans * Create README.md * renamed all github links * renamed more github links * Added team's Event Types * Clarified the Google Meet integration * Spelling error * Added primary calendar tutorial * Removed tutorial * primary calendar selection * Moved to subdirectory * Matching configs * Shares eslint config between web and docs * Removes format-schemas * Updates env file location in turbo * [docs] updates monorepo intructions Co-authored-by: baileypumfleet <pumfleet@hey.com> Co-authored-by: Peer Richelsen <peeroke@gmail.com> Co-authored-by: milospuac <97884287+milospuac@users.noreply.github.com> Co-authored-by: Peer Richelsen <peeroke@richelsen.net>
2022-02-11 19:33:35 +00:00
# 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/
```