suiet/sui-coin-list

Sui Coin List maintained by Suiet

Suiet, the wallet designed for everyone

If you want to know how to install/use suiet, please visit our offical website suiet.app or docs

Warning Suiet is current on devnet, we may make break changes before the mainnet of Sui goes online.

🚀 Getting Started

⚙️ Prepare the enviroment

1. Make sure you have nodejs install with npm
2. Clone the suiet main repo

git clone [email protected]:suiet/suiet.git

3. Install the dependencies

npm install

🏁 Run app in your browser

Run the following command at the root path of the project

npm start

Then load the extension dist folder packages/chrome/dist in Chrome #detail

And you can use the app in your chrome under development mode.

🚀 Getting Started (App)

⚙️ Prepare the enviroment (App)

First you need to prepare the enviroment for the Chrome Ext, please follow the Getting Started section.

Addtionally, you need to install the dependencies for the app workspace:

We did not use monorepo for the app workspace (packages/expo) to workaround React Native build, so you need to install the dependencies manually.

cd packages/expo
npm install

Get development build of the app

You need a development build to run the app in your phone.

We have setup a automatic build in GitHub Actions, you can download the latest build in GitHub Actions page. After you get .ipa and .apk file in the artifacts, you need to install the app in your phone.

No additional steps is needed for Android to install the .apk. But for iOS, you must be a member of Suiet Team to install the .ipa because it is accociated with a developer account and certain devices, sorry for the inconvenience.

(Optional) Build the app yourself

This is an optional step, you can skip this step if you are able to use the automatic build. But if you want to proceed, it is easy to do so because this project is based on Expo.

You need to setup a development environment for Expo, please follow the Expo documentation.

After you setup the environment, you can build the app with the following command:

# build for android
$ eas build -p android --local --profile=development
# or for ios
$ eas build -p ios --local --profile=development

🏁 Run app in your phone

After you get the development build, you can run the app in your phone. Start the development server with the following command:

cd packages/expo
npm run start

Then you can scan the QR code in the terminal with your phone camera.

👨‍💻👩‍💻 Develop the app

You can use previous development builds until you add / change native packages. Changes to the JavaScript / TypeScript code will take effect immediately. The develop experience is similar to React Native.

Before you commit your changes, you should test the app on both Android and iOS.