Skip to main content

QuickBuild

The QuickBuild tool is a powerful wizard designed to fast-track your integration with SyAuth. It guides you through a step-by-step configuration process and generates a complete environment configuration file ready for your application.

Overview​

QuickBuild handles the complexity of setting up:

  • OAuth Clients
  • API Tokens
  • External Identity Providers (Social Login)
  • Redirect URIs
  • Scopes

At the end of the process, you receive a ready-to-use .env.local file snippet that you can drop directly into your project.

Using QuickBuild​

To access QuickBuild, go to the Dashboard Home page and locate the QuickBuild card (highlighted in blue) within the Quick Access section. Click the card to launch the wizard.

Step 1: Technology Selection​

Choose your technology stack. Currently supported:

  • Next.js: Full support for Next.js App Router and Pages Router.
  • Django: Seamless integration with the django-syauth package.
  • Node.js (Coming Soon)

Step 2: Use Case Selection​

Select how you want to integrate SyAuth:

  • App Integration (SDK): Best for standard web applications. Uses the @syauth/nextjs or django-syauth SDKs for seamless authentication flow.
  • Custom Login Page: Best if you are building a custom login UI that interacts directly with the SyAuth API.

Step 3: Basic Information​

Enter the core details for your setup:

  • Company Name: Your organization's name.
  • Admin Contact: The primary email for administrative notifications.
  • Application Name: (Optional) specific name for this app integration.

Step 4: Authentication Methods​

Choose which authentication strategies to enable:

  • Email & Password: Standard local authentication.
  • OAuth / OpenID Connect: Required for social logins and standard protocol support.
    • Redirect URIs: Where users are sent after logging in (e.g., http://localhost:3000/auth/callback).
    • Allowed Scopes: Permissions requested (default: openid profile email).

Step 5: External Providers​

Configure social login providers in one go. You can enable and configure:

  • Google
  • GitHub
  • LinkedIn
  • Facebook

For each selected provider, you can directly input the Client ID and Client Secret. QuickBuild defaults the callback URL to the standard SyAuth endpoint: https://api.syauth.com/e/v1/oauth/{provider}/callback/

Step 6: Review & Build​

Review your configuration summary. When you click Build, SyAuth will:

  1. Use the currently active Workspace in your dashboard.
  2. Create/Configure the OAuth Client.
  3. Generate necessary API Tokens.
  4. Configure all selected External Providers.

Output​

Once the build is complete, QuickBuild presents a configuration block tailored to your selected use case.

Example Next.js Configuration (.env.local):

# SyAuth SDK Configuration
NEXT_PUBLIC_SYAUTH_API_URL=https://api.syauth.com/e/v1
NEXT_PUBLIC_SYAUTH_CLIENT_ID=...
NEXT_PUBLIC_SYAUTH_API_KEY=...
NEXT_PUBLIC_SYAUTH_REDIRECT_URI=http://localhost:3000/auth/callback
NEXT_PUBLIC_SYAUTH_SCOPES=openid,profile,email
NEXT_PUBLIC_REDIRECT_AFTER_LOGIN=/dashboard

Example Django Configuration (.env):

# SyAuth Django Configuration
SYAUTH_API_URL=https://api.syauth.com/e/v1
SYAUTH_CLIENT_ID=...
SYAUTH_API_KEY=...
SYAUTH_REDIRECT_URI=http://localhost:8000/auth/callback/
SYAUTH_SCOPES=openid profile email

Next Steps​

  1. Copy or Download the configuration.
  2. Paste it into your project's .env.local file.
  3. Run your development server.

Security Note: This configuration contains sensitive potential secrets (depending on the flow). Ensure you never commit .env files to version control.