Skip to content
/ react Public

Blux is a comprehensive authentication connect kit designed to simplify and enhance the onboarding experience for dApps within the Stellar ecosystem.

License

Notifications You must be signed in to change notification settings

bluxcc/react

Repository files navigation

Blux Wallet Kit - The Missing Piece for Stellar dApps

Blux is a comprehensive authentication and wallet connect kit designed for Stellar dApps. It simplifies onboarding by integrating multiple authentication methods, including wallets, email, phone, and OAuth. With Blux, developers can create seamless multi-auth experiences without the complexity of building custom authentication solutions from scratch.

Features

  • Multi-Wallet Support: Easily integrate Stellar wallets such as Rabet, xBull, Lobstr, Freighter, and Albedo.
  • OAuth & Social Login (Coming Soon): Support for Apple, Meta, Google, and more.
  • Email & Phone Authentication (Coming Soon): Securely onboard users with non-crypto credentials.
  • Customizable UI: Adjust themes, fonts, backgrounds, logos, border radius, and text colors.
  • Configurable Networks: Set up and modify network preferences via API keys.
  • Future-Proof: More wallets and authentication methods will be added based on community feedback.

Installation

Blux can be installed via npm:

npm i @bluxcc/react

or using yarn:

yarn add @bluxcc/react

Usage

Import Blux and set up the authentication flow:

import { BluxProvider, useBlux, networks } from '@bluxcc/react';

const ConnectButton = () => {
  const { login } = useBlux();

  return <button onClick={login}>Login</button>;
};

const App = () => {
  const config = {
    appName: 'Your App',
    networks: [networks.mainnet, networks.testnet],
    defaultNetwork: networks.mainnet,
  };

  return (
    <BluxProvider config={config}>
      <ConnectButton />
    </BluxProvider>
  );
};

export default App;

Customization

Developers can customize various UI elements:

  • Themes & Fonts
  • Backgrounds, Logos
  • Border Radius & Text Colors
  • Authentication Limits (Free tier supports 500-1000 accounts per auth method)

Configuration options can be set via the BluxProvider config or environment variables.

Supported Wallets

Currently supported connection methods:

  • Rabet
  • xBull
  • Lobstr
  • Freighter
  • Albedo
  • Ledger
  • Trezor
  • Hana
  • WalletConnect
  • OAuth
  • Email
  • Phone

License & Usage Restrictions

  • No Production Use Until 2028: This software is provided under the Blux Team License with restrictions on production use.
  • No Forking or Unauthorized Modifications: Removing references to Blux Team or forking without attribution is strictly prohibited.
  • Custom Licensing Available: Contact us at support@blux.cc to discuss licensing options.

Support & Contact

For support, licensing, or inquiries, reach out via:

Roadmap & Future Plans

Blux is evolving. Follow our updates on X (Twitter) for:

  • OAuth Authentication (Apple, Meta, Google, etc.)
  • Email & Phone-Based Authentication
  • More Wallet Integrations
  • Enhanced Customization & Security Features

Stay tuned. We have many exciting developments ahead!

About

Blux is a comprehensive authentication connect kit designed to simplify and enhance the onboarding experience for dApps within the Stellar ecosystem.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •