Skip to content

Getting Started

www0abdb-oss edited this page Sep 6, 2026 · 1 revision

Getting Started

This guide explains how to set up the NexVaultX frontend locally for development.

Prerequisites

Before starting, make sure you have the following installed:

  • Node.js — a supported LTS version
  • PNPM — the package manager used by the project
  • Git — for cloning and managing the repository

You can verify your installations with:

node --version
pnpm --version
git --version

Clone the Repository

Clone the frontend repository:

git clone https://github.com/NexVaultX/frontend.git

Enter the project directory:

cd frontend

Install Dependencies

Install the project's dependencies using PNPM:

pnpm install

Environment Variables

Create a local environment file if the project requires environment variables:

cp .env.example .env

Configure the required values inside .env.

Never commit secrets or private credentials to the repository.

Start the Development Server

Start the development server with:

pnpm dev

Once the server starts, open the local development URL shown in your terminal.

Development

During development, changes made to the source code are automatically reflected by the development server.

The main source code is located inside:

src/

Before submitting changes, make sure the project builds and passes its checks.

Useful Commands

Development

pnpm dev

Starts the development server.

Build

pnpm build

Creates a production build.

Lint

pnpm lint

Checks the codebase for linting issues.

Format

pnpm format

Formats the project according to the configured code style.

Next Steps

After successfully running the project locally, continue with:

Troubleshooting

If you encounter problems during setup, check the Troubleshooting page before opening an issue.