[Draft] Implement onboarding wizard and allow google SSO login configuration
- Introduced a comprehensive onboarding API with multiple endpoints for managing onboarding steps, including authentication, data sources, and user configurations.
- Added middleware to check onboarding status and cache results to optimize API calls.
- Implemented Google OAuth integration with validation and configuration management.
- Enhanced user experience by redirecting users based on onboarding status.
- Created new components for onboarding UI and improved data handling in the onboarding process.
- Updated database schema to support onboarding progress tracking.
This commit lays the groundwork for a streamlined onboarding experience, ensuring users can efficiently set up their applications.
๐ Pull Request Summary
๐ Related Issues
- Fixes #
- Relates to #
๐ Changes Made
๐งช Testing
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing performed
- [ ] All existing tests pass
Testing Details:
๐ Documentation
- [ ] Code is self-documenting with clear variable/function names
- [ ] Added/updated JSDoc comments for public APIs
- [ ] Updated README.md if needed
- [ ] Updated other documentation files
- [ ] No documentation changes needed
๐ Type of Change
- [ ] ๐ Bug fix (non-breaking change that fixes an issue)
- [ ] โจ New feature (non-breaking change that adds functionality)
- [ ] ๐ฅ Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] ๐ Documentation update
- [ ] ๐ง Refactoring (no functional changes)
- [ ] โก Performance improvement
- [ ] ๐งช Test improvements
๐จ Breaking Changes
- [ ] This PR introduces breaking changes
- [ ] Migration guide provided
- [ ] Deprecation warnings added
Breaking Change Details:
๐ธ Screenshots/Videos
๐ Additional Notes
Summary of Changes
Hello @ATechAdventurer, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request delivers a foundational onboarding wizard designed to simplify the initial setup experience for new users. It provides a guided, step-by-step process for configuring essential application settings, with a particular focus on authentication. The wizard now supports Google SSO integration, allowing for dynamic credential management and streamlined admin user creation. Supporting this, a new set of API endpoints and database schema have been introduced to manage onboarding state, alongside middleware to ensure a seamless flow between setup and application usage.
Highlights
- Comprehensive Onboarding Wizard: Introduced a multi-step onboarding process for initial application setup, guiding users through authentication, data source configuration, and user management.
- Google SSO Integration: Implemented Google OAuth as a primary authentication option, allowing dynamic configuration and validation of credentials, and enabling admin users to sign in with their Google accounts.
- Dynamic Authentication Configuration: Refactored the authentication system to dynamically load and apply configurations for Google OAuth and OIDC SSO based on environment variables or settings saved during onboarding, enhancing flexibility.
-
Dedicated Onboarding API: Added a suite of new API endpoints (
/api/onboarding/*) to manage the state, progress, and configuration details for each step of the onboarding wizard. - Onboarding Flow Middleware: Implemented middleware to intelligently redirect users to the onboarding wizard if the application is not yet set up, and conversely, redirect them away from the onboarding page once the setup is complete.
-
Database Schema for Onboarding Progress: Introduced a new
OnboardingProgresstable in the database to persistently track the status and configuration data throughout the onboarding process. - Updated Documentation: Added new and updated existing documentation, including a detailed SSO Setup Guide, to assist users with configuring authentication methods.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.