SSP Wallet
  • Welcome to SSP Wallet
  • Getting Started with SSP Wallet
    • Change Language
    • Switch Chain
    • 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
      • Swap
      • Send
      • Receive
      • Export Transactions
      • View Transactions
    • Token
      • 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 RELAY DEVELOPMENT

Project Installation

PreviousEnvironment RequirementsNextProject Structure 0verview

Last updated 4 months ago

  1. Clone the SSP Relay 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:

Please use the installer and installation guide for your OS.

Open a terminal and run the following commands

mkdir ssp-relay
cd ssp-relay
git clone https://github.com/RunOnFlux/ssp-relay.git

  1. Install SSP Relay Dependencies

In installing the project dependencies you may use yarn

For installing yarn you must follow this guide:

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

yarn install

  1. Start the Service

Open a terminal and run the following command to start SSP Relay server

yarn start

By default, the SSP Relay services runs at http://127.0.0.1:9876, alternatively http://localhost:9876

Running Test Cases

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

yarn test
https://git-scm.com/
https://classic.yarnpkg.com/lang/en/docs/install