Skip to content

Latest commit

 

History

History
92 lines (58 loc) · 3.71 KB

README.md

File metadata and controls

92 lines (58 loc) · 3.71 KB
Raw

Expo Stellar Soroban Boilerplate

Expo Logo Build Status

The Expo Stellar Soroban Boilerplate is a powerful starting point for developing cross-platform native apps using Expo. It is specifically designed to connect to the Soroban futurenet and provides a comprehensive set of features to kickstart your app development process.

Todo:

  • Load account
  • Load account balance
  • Load account transactions
  • Load account & ledger events
  • Send payment
  • Swap asset
  • Load contract data
  • Wallet Connect v2 (connection, approval, signing)

Features

The boilerplate code includes the following features:

  1. Soroban SDK: The boilerplate is integrated with the Soroban SDK, allowing you to seamlessly connect to the Soroban futurenet and utilize its functionalities within your app.

  2. Soroban Horizon Wrapper SDK: Integrated with in-house maintained wrapper Expo/RN

  3. Authentication: It provides a preconfigured authentication system, enabling users to securely authenticate with the Soroban futurenet and access protected resources.

  4. Secure Storage: The boilerplate incorporates a secure storage mechanism to store sensitive user data, ensuring data confidentiality and integrity.

  5. Navigation: It includes a navigation system that allows you to easily implement navigation flows and transitions between screens in your app.

  6. Necessary Shims and Modifications: The boilerplate includes necessary shims and modifications to ensure smooth integration with Expo and Soroban futurenet.

  7. Crypto Libraries: It provides essential cryptographic libraries that facilitate secure communication and data encryption within your app.

Prerequisites

To use the Expo Stellar Soroban Boilerplate, you need to have the following software installed on your development machine:

  • Node.js: Install Node.js
  • Expo CLI: You can install the Expo CLI globally using the following command:
npm install -g expo-cli

Getting Started

To get started with the Expo Stellar Soroban Boilerplate, follow the steps below:

  1. Clone the repository using Git or download the source code directly from GitHub.
git clone https://github.com/Spxc/expo-stellar-soroban-boilerplate.git
  1. Navigate to the project directory.
cd expo-stellar-soroban-boilerplate
  1. Install the required dependencies.
npm install

  1. Open the project in your preferred code editor.

  2. Modify the necessary configurations, such as Soroban API endpoints and authentication settings, according to your project requirements.

  3. Start the Expo development server.

expo start

  1. Follow the instructions provided by Expo to run the app on an emulator, physical device, or web browser.

  2. Begin developing your app by leveraging the provided boilerplate code, integrating Soroban functionality, and customizing the user interface.

Contributing

Contributions to the Expo Stellar Soroban Boilerplate are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on GitHub.

Before contributing, please review the contribution guidelines for this project.

License

This project is licensed under the MIT License.

Contact

If you have any questions, feedback, or inquiries, you can reach out to the project