Scaffold UI

Fastest way to add authentication or in-app purchases to your Nylo Flutter application.

Overview

Scaffold UI is a powerful CLI tool that helps Flutter developers quickly integrate common UI patterns into their Nylo projects. Instead of spending hours building authentication flows or in-app purchase screens from scratch, you can have a complete, customizable implementation in minutes.

Features

🔐 Authentication UI

Generate a complete authentication flow with a single command:

dart run scaffold_ui:main auth

Choose from three authentication backends:

• Supabase - Full authentication service with ready-to-use UI components
• Laravel - Complete integration with Laravel Sanctum, including API services
• Firebase - Integration with Firebase Auth and Firestore with ready-to-use UI components
• Basic - Clean authentication UI templates for custom implementation

💳 In-App Purchases (iOS & Android)

Add subscription flows and paywalls with:

dart run scaffold_ui:main iap

Currently supports:

• RevenueCat - Complete integration with SDK and pre-built UI components for subscription management

IOS Prerequisites

• Open the ios/Runner.xcworkspace file in Xcode
• Signing & Capabilities > Add the In-App Purchase capability

Installation

Add scaffold_ui to your Flutter project:

dart pub add scaffold_ui

This will add the following to your pubspec.yaml:

dependencies:
  scaffold_ui: ^1.2.6

Setup Guides

Supabase Authentication

1. Create a Supabase account and project at supabase.com
2. Run the auth scaffold command:

   dart run scaffold_ui:main auth
   

3. Select supabase when prompted
4. Enter your Supabase URL and Anon Key
5. The tool will automatically:
   • Configure Supabase authentication
   • Generate UI components
   • Set up necessary services

Laravel Authentication

Prerequisites:

• A Laravel project with Sanctum configured
• Your User model must use the HasApiTokens trait

1. Install the Laravel package:

   composer require nylo/laravel-nylo-auth
   

2. Publish the package assets:

   php artisan vendor:publish --provider="Nylo\LaravelNyloAuth\LaravelNyloAuthServiceProvider"
   

3. Run the auth scaffold command:

   dart run scaffold_ui:main auth
   

4. Select laravel and enter your project URL

5. For additional Laravel configuration options, visit the laravel-nylo-auth repository

Firebase Authentication

1. Create a Firebase account and project at firebase.google.com
2. Run the auth scaffold command:

   dart run scaffold_ui:main auth
   

3. Select firebase when prompted
4. This will:
   • Install the Firebase SDK
   • Generate UI components
   • Set up necessary services
5. Install flutterfire via https://firebase.google.com/docs/flutter/setup
6. Run flutterfire configure to complete the setup

Basic Authentication

For custom authentication implementations:

1. Run dart run scaffold_ui:main auth
2. Select basic
3. The tool will generate UI components that you can customize with your authentication logic

Changelog

See CHANGELOG for recent changes.

License

This project is licensed under the MIT License - see the License file for details.