Feat: Add welcome modal functionality for user onboarding #250
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Short Summary
This PR introduces an onboarding flow for users who have not yet configured their OpenRouter API key. It adds a persistent "Welcome" state to the user profile and implements a modal on the home dashboard that prompts users to set up their API credentials, ensuring the application is usable immediately after signup.
Technical Changes
Database & Backend (
api/)has_seen_welcome(boolean, defaultFalse) to theUserSQLModel and associated Alembic migration (b6ac4c311f9d).POST /user/ack-welcomeinrouters/users.pyto allow the frontend to mark the onboarding as complete.sync_userandUserReadmodels to return thehas_seen_welcomestatus.mark_user_as_welcomedinuser_crud.py.Frontend (
ui/)components/ui/home/welcomeModal.vue, a styled modal featuring animations and a direct link to settings.pages/index.vue):isReadystate.server/api/auth/ack-welcome.post.tsas a proxy to the backend endpoint, which also refreshes the user session to reflect the state change immediately.github.get.ts,google.get.ts, andlogin.post.tsto includehas_seen_welcomein the session user object.types/user.d.tsto include the new boolean field.Impact and Scope
has_seen_welcomecolumn to theuserstable.False, meaning they may see the modal once if they haven't configured an API key, which is intended behavior.