Repository navigation
Project Structure
This page provides an overview of the NexVaultX frontend project structure and explains the purpose of the main directories and files.
The NexVaultX frontend is organized to keep application logic, UI components, routing, configuration, and static assets separated and easy to maintain.
frontend/
├── src/
│ ├── components/
│ ├── routes/
│ ├── lib/
│ └── ...
├── public/
├── package.json
├── pnpm-lock.yaml
├── tsconfig.json
├── vite.config.ts
└── ...
The structure may change as NexVaultX continues to evolve.
The src directory contains the main application source code.
Contains reusable UI components used throughout the application.
Components should generally be kept reusable and focused on a specific UI responsibility.
Examples may include:
- Navigation
- Buttons
- Cards
- Dialogs
- Forms
- Layout components
- Content components
Contains the application's routes and page-level components.
Each route represents a part of the NexVaultX web application and is responsible for rendering the appropriate page.
Routing is handled using TanStack Router.
Contains shared utilities, helpers, and application-level logic that does not belong directly to a UI component.
This directory should be used for reusable functionality shared across multiple parts of the application.
Contains static assets that are served directly by the application.
These files do not require processing through the application's component system.
Defines the project metadata, dependencies, and available scripts.
Common development commands are defined here.
Locks dependency versions to ensure consistent installations across development environments and CI.
This file should normally be committed whenever dependencies are changed.
Contains the TypeScript configuration used by the project.
Contains configuration related to the Vite build and development environment.
When adding new code:
- Keep components small and reusable.
- Keep page-specific logic close to its route.
- Move reusable utilities into
src/lib/. - Avoid duplicating existing functionality.
- Keep TypeScript types explicit and maintainable.
- Follow the existing project conventions before introducing new patterns.
Before adding a new file or directory, consider whether the functionality belongs in an existing location.
A clean project structure makes NexVaultX easier to:
- Develop
- Review
- Maintain
- Contribute to
- Scale
For the development process, see Development Workflow.
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.