Skip to content

How to Run project locally

Prerequisites

  • Node.js: Required for package management and running the build server (v18+ recommended).
  • npm: Node Package Manager.
  • Git: For downloading the source code.

Download & Setup

  1. Clone the Repository Download the project source code to your local machine.

    bash
    git clone <repository-url>
    cd united-non-custodial-front
  2. Install Dependencies Install the required Node.js packages.

    bash
    npm install
  3. Environment Configuration Defined in the setup documentation, this interface maps environment variables to internal configuration.

    • cardsKey: Cryptographic key.
    • cardsIvKey: Initialization vector.
    • environment: Runtime environment name.

    The application relies on specific environment variables. You can export them in your shell session before running the application.

    bash
    export UNITED_CARDS_KEY="your_key_here"
    export UNITED_CARDS_IV_KEY="your_iv_key_here"
    export ENVIRONMENT_NAME="development"

Execution

  1. Run Development Server Starts the local development server using Vite with Hot Module Replacement (HMR).
    bash
    npm run dev
    The application will be accessible at http://localhost:8080.