Welcome to the frontend repository of AuthChain, a blockchain-based authentication system. This project is designed to provide a secure and decentralized two-factor authentication mechanism that integrates seamlessly with any website, enhancing user privacy and security in Web3 applications.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Before you begin, ensure you have the following installed:
- Node.js and npm (npm comes with Node.js)
To set up the development environment, follow these steps:
- Clone the repository:
git clone https://github.com/Damso74/AuthChain-Frontend-V1.git- Navigate to the project directory:
cd AuthChain-Frontend-V1- Install the necessary dependencies using npm:
npm install vite- Start the development server:
npm startAfter running the above command, the AuthChain site should be up and running on your local server. You can access it by going to http://localhost:3000 in your web browser.
AuthChain is designed as a standalone frontend application that can also function as a plug-and-play module for user database management. If you wish to integrate AuthChain into your existing website, please refer to our integration guide in the docs directory.
If you need help or have any questions, feel free to open an issue in the repository, and we'll be happy to assist you.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the project.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a pull request.
Distributed under the MIT License. See LICENSE for more information.
AuthChain is a decentralized application (dApp) that leverages blockchain technology to provide a robust and secure authentication system. Our design focuses on user privacy, employing a combination of smart contracts and off-chain computations to ensure user data integrity without compromising security.
The dApp architecture comprises three main components:
- Smart Contracts: Manage the authentication logic and user credentials securely on the Ethereum blockchain.
- Off-Chain Storage: Uses decentralized storage solutions for sensitive data that shouldn't be on-chain, ensuring data privacy.
- Frontend Interface: A user-friendly interface built with React, providing seamless interaction with the blockchain features.
A working prototype of the AuthChain dApp is available for review. The complete source code is hosted on GitHub, which you can access, fork, and review.
Repository Link: AuthChain Frontend GitHub
We've provided detailed documentation to help you set up, deploy, and use AuthChain. It covers every aspect of the dApp, from smart contracts to the frontend setup. The documentation for the API and SDK is currently under construction.
Watch a brief demo video showcasing how AuthChain works and its various functionalities.
Demo Video Link: AuthChain Demo