Skip to content
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

Update Convex Example #39562

Merged
merged 7 commits into from
Aug 16, 2022
Merged

Update Convex Example #39562

merged 7 commits into from
Aug 16, 2022

Conversation

alexcole
Copy link
Contributor

This makes a few changes to the Convex example app.

We're using this example app in the Convex quick start (https://docs.convex.dev/quick-start), so I want to make sure we're setting new users up for success.

  • Upgrade to the newest version of Convex (includes adding a tsconfig.json for Convex functions)
  • Switch to pinning Convex to latest
  • Check in generated code so the example will make more sense to users browsing on GitHub or before they regenerate the code. This required ignoring it in the global .prettierignore
  • Add prettier
  • Update styling so "Powered by Convex" appears on screen.
  • Switch the syntax of one function to make it type check after developers add a schema

Documentation / Examples

  • Make sure the linting passes by running pnpm lint
  • The examples guidelines are followed from our contributing doc

@ijjk ijjk added the examples Issue/PR related to examples label Aug 12, 2022
@ijjk ijjk merged commit 11bd44f into vercel:canary Aug 16, 2022
@alexcole alexcole mentioned this pull request Aug 18, 2022
2 tasks
ijjk pushed a commit that referenced this pull request Aug 19, 2022
This is a followup to #39562 because I realized I made a few mistakes.

Remove convex.json file. Developers using the example should generate this on their own by running npx convex init.
Switch prettier to a dev dependency.
Ignore formatting in Convex generated code while running lint-staged and revert them back to the default generated form (I previously was only ignoring generated code in the main .prettierignore)
Change a let to a const

cc @thomasballinger
Documentation / Examples

 Make sure the linting passes by running pnpm lint
 The examples guidelines are followed from our contributing doc
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
examples Issue/PR related to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants