SSP Wallet
  • Welcome to SSP Wallet
  • Getting Started with SSP Wallet
    • Change Language
    • Wallet
      • Retrieve SSP Wallet Seed Phrase
      • Create a New Wallet
      • Restore Wallet Using Seed Phrase
      • Create Multiple Wallet
      • Delete a Wallet
      • Retrieving Your Wallet Address
    • Transaction
      • Buy / Sell
      • Send
      • Receive
      • Export Transactions
      • View Transactions
    • Token
      • Switch Chain
      • Add Token to Main Screen
      • Remove Token from Main Screen
    • Custom Tokens
      • Add Custom Token
      • Delete Custom Token
    • Contacts
      • Create New Contact
      • Edit Contact
      • Delete Contact
    • Logout Your SSP Wallet
  • GETTING STARTED WITH SSP KEY
    • Install SSP Key
    • Create a New Key and Syncing to SSP Wallet
    • Restore Key Using Seed Phrase and Syncing to SSP Wallet
    • Retrieving Your SSP Key Seed Phrase
    • Using Your SSP Key For Syncing
  • GETTING STARTED WITH SSP RELAY DEVELOPMENT
    • Overview
    • Environment Requirements
    • Project Installation
    • Project Structure 0verview
    • Project Folders
      • Config
      • Helpers
      • Logs
      • Src
        • apiServices
        • lib
        • services
        • routes.ts
          • GET /v1/sync
          • GET /v1/action
          • POST /v1/sync
          • POST /v1/token
          • POST /v1/action
          • GET /v1/rates
          • GET /v1/networkfees
          • POST /v1/ticket
          • GET /v1/tokeninfo
          • GET /v1/services
          • POST /v1/sign
      • Tests
        • unit
  • GETTING STARTED WITH SSP WALLET DEVELOPMENT
    • Overview
    • Environment Requirements
    • Project Installation
    • SSP Wallet API
    • Project Structure Overview
    • Project Folders
      • Public
        • scripts
      • Patches
      • Src
        • assets
        • components
        • contexts
        • hooks
        • lib
        • pages
        • storage
        • store
        • translations
      • Tests
        • lib
  • GETTING STARTED WITH SSP KEY DEVELOPMENT
    • Overview
    • Environment Requirements
      • For Mac Users Only
    • Project Installation
    • Project Structure Overview
    • Project Folders
      • Types
      • Src
        • assets
        • components
        • contexts
        • hooks
        • lib
        • navigators
        • screens
        • storage
        • store
        • themes
        • translations
      • Tests
        • lib
Powered by GitBook
On this page
  1. GETTING STARTED WITH SSP KEY DEVELOPMENT

Project Installation

  1. Clone the SSP Key Repository

Before cloning the repository, please make sure you have git installed in your local environment.

If you don't have git on your local machine please follow the link: https://git-scm.com/

Please use the installer and installation guide for your OS.

Open a terminal and run the following commands

mkdir ssp-key
cd ssp-key
git clone git@github.com:RunOnFlux/ssp-key.git

  1. Install SSP Key Dependencies

In installing the project dependencies you may use yarn

For installing yarn you must follow this guide:

https://classic.yarnpkg.com/lang/en/docs/install

Open a terminal and run the following command to install SSP Key dependencies

yarn
bundle update --bundler
yarn bundleinstall
yarn podinstall

Running Test Cases

To run SSP Key test cases, open a terminal and run the following command

yarn test

Running the Server

To run SSP Key server, open a terminal and run the following command

yarn start

Running on Android

Open a terminal and run the following command

yarn android

Running on iOS

yarn ios
PreviousFor Mac Users OnlyNextProject Structure Overview

Last updated 1 month ago