README.md

Alephex

Alephex is a decentralized token swap application built on the Alephium blockchain. It enables users to exchange various tokens seamlessly while ensuring security and transparency. The application leverages the unique capabilities of Alephium's blockchain to provide a user-friendly interface for token exchanges.

Getting Started

Start a local devnet for testing and development. Please refer to the Getting Started documentation.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js installed on your machine.
• A code editor such as Visual Studio Code.
• A wallet compatible with Alephium (e.g., Alephium Wallet).
• Alephium Devnet to interact with the contracts

Installation

1. Clone the repository:

   git clone https://github.com/nipudas29/Alephex.git

2. Navigate to the project directory:

   cd Alephex

3. Install the required dependencies:

   npm install

4. Start the development server:

   npm run dev

5. Open your browser and go to http://localhost:3000 to view the application.

Usage

1. Connect your Alephium wallet.
2. Select the tokens you wish to swap.
3. Enter the amount you want to exchange.
4. Review the transaction details and confirm the swap.
5. Your tokens will be exchanged directly in your wallet.

Contributing

Contributions are welcome! If you want to contribute to Alephex, please follow these steps:

1. Fork the repository.

2. Create a feature branch:

   git checkout -b feature/YourFeature

3. Commit your changes:

   git commit -m 'Add some feature'

4. Push to the branch:

   git push origin feature/YourFeature

5. Open a pull request.

License

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

Acknowledgments

• Alephium for providing the blockchain infrastructure.
• All contributors are responsible for their valuable input and improvements.

Contact

For inquiries or feedback, please reach out to [email protected]