search

pingdotgg / uploadthing

File uploads for modern web devs
https://uploadthing.com
MIT License
4.27k stars 319 forks source link

chore: Add `tanstack/start` example and fix docs #981

Closed juraj98 closed 2 months ago

juraj98 commented 2 months ago

This PR is mainly to add example for tanstack/start. The example works if it's started outside of the UT repo, but throws Uncaught TypeError: $RefreshSig$ is not a function if started from the repo. No idea why that is. I'm opening this draft pull request in case someone already encountered this issue and knows a quick fix. Otherwise, I'll revisit this in a few days.

There are also additional changes to docs for getting started in tanstack/start:

Summary by CodeRabbit

Release Notes

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: ba4a6a5b80c1f1bc964c6f7b046b654a3762516f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 2 months ago

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

Name Status Preview Comments Updated (UTC)
docs-uploadthing ❌ Failed (Inspect) Sep 24, 2024 0:25am
1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **legacy-docs-uploadthing** | ⬜️ Ignored ([Inspect](https://vercel.com/pinglabs/legacy-docs-uploadthing/r6y6Xew1d9gUxjWyE6RyzNT3rSoR)) | [Visit Preview](https://legacy-docs-uploadthing-git-fork-juraj98-main-pinglabs.vercel.app) | | Sep 24, 2024 0:25am |
coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces several enhancements to the uploadthing repository, including the addition of a new example using Tanstack/Start in the README.md, updates to import paths and CSS handling in the documentation, and the introduction of various new files for a minimal Tanstack application setup. These changes collectively improve the documentation and provide a foundational structure for users to build upon when implementing file uploads with UploadThing.

Changes

File Path Change Summary
README.md Added a new example entry for Tanstack/Start.
docs/src/app/(docs)/getting-started/tanstack-start/page.mdx Updated import paths and CSS inclusion instructions.
examples/minimal-tanstack-start/.env.example Introduced a new environment variable configuration file with a placeholder for UPLOADTHING_TOKEN.
examples/minimal-tanstack-start/app.config.ts Added a new configuration file with a basic setup for the application.
examples/minimal-tanstack-start/app/api.ts Introduced a new API handler file for handling uploads with TanStack.
examples/minimal-tanstack-start/app/client.tsx Added a React application entry point utilizing Tanstack/Start.
examples/minimal-tanstack-start/app/routeTree.gen.ts Created a routing structure file with defined interfaces and route configurations.
examples/minimal-tanstack-start/app/router.tsx Defined a function to create a router and extended the routing framework.
examples/minimal-tanstack-start/app/routes/__root.tsx Introduced a root route component for the application layout.
examples/minimal-tanstack-start/app/routes/api/uploadthing.ts Set up an API route for file uploads.
examples/minimal-tanstack-start/app/routes/index.tsx Created a file upload interface with real-time feedback for users.
examples/minimal-tanstack-start/app/server/uploadthing.ts Implemented a file upload router with custom error handling and configuration.
examples/minimal-tanstack-start/app/ssr.tsx Set up a server-side rendering handler for the application.
examples/minimal-tanstack-start/app/utils/uploadthing.ts Integrated UploadThing functionalities with reusable components and hooks.
examples/minimal-tanstack-start/package.json Introduced a package.json file with project dependencies and scripts.
examples/minimal-tanstack-start/tsconfig.json Added a TypeScript configuration file with specified compiler options.

Possibly related PRs

Suggested labels

@uploadthing/react

Suggested reviewers

Poem

In the garden where we play,
New examples bloom today.
With uploads flying high and free,
Tanstack's magic, come and see!
Hops of joy, a code delight,
Let's share this with all in sight! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: -- `@coderabbitai generate unit testing code for this file.` -- `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@coderabbitai read src/utils.ts and generate unit testing code.` -- `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` -- `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
juraj98 commented 2 months ago

@coderabbitai review

coderabbitai[bot] commented 2 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
juraj98 commented 2 months ago

Closing this PR. The scope to make this work keeps growing. I'll create separate PRs for the doc changes, update for solidstart example, and finally the tanstack/start example.