This is a Convex project created with npm create convex.
After the initial setup (<2 minutes) you'll have a working full-stack app using:
- Convex as your backend (database, server logic)
- React as your frontend (web page interactivity)
- Vite for optimized web hosting
- Tailwind for building great looking accessible UI
- WorkOS AuthKit for authentication
If you just cloned this codebase and didn't use npm create convex, run:
npm install npm run dev If you're reading this README on GitHub and want to use this template, run:
npm create convex@latest -- -t react-vite-workos-authkit Then:
- Sign up for WorkOS and create an application
- Copy
.env.local.exampleto.env.localand configure:VITE_WORKOS_CLIENT_ID: Your WorkOS client IDVITE_WORKOS_REDIRECT_URI: Your redirect URI (default: http://localhost:5173/callback)VITE_CONVEX_URL: Your Convex deployment URL
- Configure your WorkOS client ID as
WORKOS_CLIENT_IDin your Convex dashboard environment variables
For user management and webhook integration with WorkOS, check out the WorkOS documentation.
To learn more about developing your project with Convex, check out:
- The Tour of Convex for a thorough introduction to Convex principles.
- The rest of Convex docs to learn about all Convex features.
- Stack for in-depth articles on advanced topics.
Join thousands of developers building full-stack apps with Convex:
- Join the Convex Discord community to get help in real-time.
- Follow Convex on GitHub, star and contribute to the open-source implementation of Convex.