Repository navigation
Getting Started
This guide explains how to set up the NexVaultX frontend locally for development.
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 --versionClone the frontend repository:
git clone https://github.com/NexVaultX/frontend.gitEnter the project directory:
cd frontendInstall the project's dependencies using PNPM:
pnpm installCreate a local environment file if the project requires environment variables:
cp .env.example .envConfigure the required values inside .env.
Never commit secrets or private credentials to the repository.
Start the development server with:
pnpm devOnce the server starts, open the local development URL shown in your terminal.
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.
pnpm devStarts the development server.
pnpm buildCreates a production build.
pnpm lintChecks the codebase for linting issues.
pnpm formatFormats the project according to the configured code style.
After successfully running the project locally, continue with:
If you encounter problems during setup, check the Troubleshooting page before opening an issue.
Welcome to the NexVaultX Wiki.
NexVaultX is an open-source platform for discovering, sharing, and managing Minecraft community content, including mods, plugins, resource packs, datapacks, shaders, and more.
This Wiki contains technical documentation for contributors and developers working on NexVaultX.
Repository: [NexVaultX/frontend](https://github.com/NexVaultX/frontend)
License: Apache-2.0
NexVaultX frontend is built with:
- React 19
- TypeScript
- TanStack Start
- TanStack Router
- TanStack Query
- Tailwind CSS
- shadcn/ui
- PNPM
- Ultracite
The repository uses a development-to-production workflow:
main → prod → production
The main branch is used for active development. Tested and ready changes are merged into prod, which triggers the production deployment.
NexVaultX is actively under development. Documentation will evolve alongside the platform.
If you are contributing to NexVaultX, start with Getting Started and then review the Development Workflow.