Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.45 KB

README.md

File metadata and controls

73 lines (47 loc) · 2.45 KB
Raw

🔐 IQAuth Demo

🌟 Introduction

The IQAuth Demo is a demonstration of authentication features built using wagmi functions. It showcases functionalities like message signing, message verification, and typed data signing, making it easier to integrate web3-based authentication into your applications. This project is a work in progress, and contributions are highly encouraged to expand its capabilities!

📦 Installation

To get started, clone the repository and install the necessary dependencies:

git clone https://github.com/Adebesin-Cell/IQauth-demo.git
cd IQauth-demo
pnpm install

🛠️ Features

The demo currently includes the following features:

  1. Message Signing: Allows users to sign messages using their web3 wallet.
  2. Message Verifying: Verifies signed messages to ensure integrity.
  3. Typed Data Signing: Supports signing typed structured data for more complex use cases.

These features are built using wagmi’s authentication functions.

🔧 Setup

  1. Environment Variables: Set up the necessary environment variables in your .env file:
# .env
NEXT_PUBLIC_PROJECT_ID=YOUR_PROJECT_ID
NEXT_PUBLIC_API_KEY=YOUR_API_KEY
NEXT_PUBLIC_NETWORK_ID=YOUR_NETWORK_ID
  1. Run the application: Start the development server by running:
pnpm run dev
  1. Access the demo: Open the demo in your browser at http://localhost:3000 to start using the message signing and verification functionalities.

🔑 Using Authentication Features

You can explore the following authentication features in this demo:

1. Message Signing

2. Message Verifying

3. Typed Data Signing

🚀 Contributing

This project is in the early stages, and we would love your help! Whether it’s fixing bugs, adding new features, or improving existing ones, contributions are welcomed.

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Commit your changes (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature/your-feature).
  5. Create a pull request, and let’s collaborate!

🎨 Future Improvements

Some of the areas that need enhancement:

  • User interface for better interaction.
  • Integration with other authentication methods.

💬 Support

If you run into any issues or have questions, feel free to open an issue on the GitHub repository or reach out to the community for support.