Skip to content

Commit

Permalink
📝 docs: Add info on CI workflows, explain more on packages/configs
Browse files Browse the repository at this point in the history
  • Loading branch information
aryanprince committed Jul 28, 2024
1 parent 02356ae commit 566d336
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,14 @@ Campus Hub is a monorepo managed by [Turborepo](https://turbo.build/repo). The m
```text
.
├── .github # GitHub Actions CI/CD workflows
│ └── workflows # CI with pnpm cache setup
│ └── workflows # CI with pnpm cache + shared GH Actions composite workflow step for all jobs
│ ├── build # Build monorepo w/ Turborepo's Remote Cache for fast builds
│ ├── e2e-test # Run E2E tests w/ Playwright & Docker Compose for local DBs
│ ├── vercel (deploy) # Automatically deploy Next.js apps to Vercel on push
│ ├── commitlint # Lint commit messages to Gitmoji standard using commitlint
│ ├── lint # Lints entire monorepo using shared ESLint config
│ ├── format # Formats entire monorepo using Prettier
│ └── typecheck # Typechecks entire monorepo using shared TS config
├── .husky # Git pre-commit hooks for commit messages and linting
├── .vscode # Recommended extensions and settings for VSCode
Expand All @@ -55,16 +62,18 @@ Campus Hub is a monorepo managed by [Turborepo](https://turbo.build/repo). The m
├── tooling # Shared configuration setup for the apps and packages
│ ├── config-eslint # Shared, fine-grained, ESLint preset
│ ├── config-playwright # Shared Playwright configuration for E2E tests
│ ├── config-prettier # Shared Prettier configuration
│ ├── config-tailwind # Shared Tailwind CSS configuration
│ ├── config-typescript # Shared TS config all apps under the monorepo
│ └── github-actions # Shared GitHub Actions composite workflow step for all CI jobs
├── .nvmrc # Node Version Manager (nvm/fnm) file (pinned to LTS)
├── docker-compose.yml # Docker Compose file for local development databases
├── .npmrc # NPM configuration file for pnpm workspaces
├── .nvmrc # Node Version Manager (nvm/fnm) file for setting a specific Node version in the monorepo
├── commitlint.config.ts # Commitlint configuration for Gitmoji commit messages
├── pnpm-workspace.yaml # pnpm config using catalogs for unified dependencies across monorepo
├── pnpm-workspace.yaml # pnpm workspace config using catalogs for unified dependencies across monorepo
├── renovate.json # Renovate configuration for automated dependency updates
├── docker-compose.yml # Docker Compose file for local development databases
└── turbo.json # Turborepo configuration file (includes all tasks)
```

Expand Down

3 comments on commit 566d336

@vercel
Copy link

@vercel vercel bot commented on 566d336 Jul 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

campus-hub-library – ./apps/library

campus-hub-library.vercel.app
campus-hub-library-aryp.vercel.app
campus-hub-library-git-main-aryp.vercel.app

@vercel
Copy link

@vercel vercel bot commented on 566d336 Jul 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

campus-hub-student – ./apps/student

campus-hub-student-aryp.vercel.app
campus-hub-student.vercel.app
campus-hub-student-git-main-aryp.vercel.app

@vercel
Copy link

@vercel vercel bot commented on 566d336 Jul 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

campus-hub-finance – ./apps/finance

campus-hub-finance-aryp.vercel.app
campus-hub-finance-git-main-aryp.vercel.app
campus-hub-finance.vercel.app

Please sign in to comment.