Skip to content

example monorepo using turbo #2650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed

Conversation

rossnelson
Copy link
Collaborator

@rossnelson rossnelson commented Apr 5, 2025

Description & Motivation 💭

Cause why not. 😬

This PR introduces a significant restructuring of the project by renaming and
relocating files to align with a new directory structure. The changes aim to
improve project organization and maintainability. Additionally, minor updates
were made to configuration files to reflect the new structure.

CleanShot 2025-04-04 at 22 04 12@2x

Key Changes:

  • File Relocation: Moved files from the server and src directories into apps/server and apps/ui respectively.
  • New Configurations: Added .tool-versions to specify Node.js and Bun versions.
  • Updated .gitignore: Adjusted paths to match the new directory structure.
  • Husky Pre-commit Hook: Updated to use turbo lint-staged for improved performance.

Testing 🧪

How was this tested 👻

  • Manual testing of the application after restructuring.
  • Unit tests to ensure no regressions.
  • E2E tests to validate functionality across the application.

Steps for others to test: 🚶🏽‍♂️🚶🏽‍♀️

  1. Pull the branch and install dependencies.
  2. Verify the application builds and runs without errors.
  3. Run all tests to ensure they pass.
  4. look at the package.json scripts and try them out.

Checklists

Draft Checklist

  • Verify all paths in configuration files are updated correctly.
  • Ensure all tests pass after restructuring.
  • update gitub actions to reflect the new structure.

Merge Checklist

  • Confirm no breaking changes in the application.
  • Validate that the new directory structure is consistent and logical.

Issue(s) closed

  • N/A

Docs

Any docs updates needed?

  • Update any references to file paths in the documentation to reflect the new structure.

- Introduced a new workspace for schemas with essential configuration
  files like `.eslintrc.cjs`, `.prettierrc`, and `.gitignore`.
- Added scripts for generating schemas and types using OpenAPI and
  `json-schema-to-zod` from [temporal-http-client](https://github.com/stevekinney/temporal-http-client)
- Configured `pnpm-workspace.yaml` to include the new schemas package.
- Updated `package.json` with necessary dependencies and scripts.

This change sets up the foundation for schema generation and management
within the project.
- Added `@temporalio/schemas` as a workspace dependency.
- Introduced `generate:schemas` script in `package.json`.

This update lays the groundwork for schema generation and ensures
compatibility with the existing code base
- Added instructions for generating schemas using `bun` or `pnpm`.
- Included examples for validating request and response payloads.
- Documented partial validation and schema structure.
Moved server and ui-related files into the `apps` directory to improve
project organization and align with monorepo structure. Updated paths
and configurations accordingly.

BREAKING CHANGE: File paths for server and ui have changed. Update any
references to the new structure under `apps/server` and `apps/ui`.
Copy link

vercel bot commented Apr 5, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
holocene ❌ Failed (Inspect) Apr 7, 2025 7:50pm

Updated the "MIGRATION_PROPOSAL.md" to include a more detailed
representation of repo, app, and package relationships using
Mermaid diagrams. Added CI/CD pipeline details and clarified
dependencies between components.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants