Repository navigation
Development Workflow
This page describes the development workflow used for the NexVaultX frontend.
NexVaultX uses separate branches for development and production.
main → prod → Production
The main branch is the primary development branch.
New features, improvements, fixes, and other changes should be developed and tested here before being released to production.
The prod branch represents the production-ready version of the frontend.
Only changes that have been tested and are ready for release should be merged into prod.
Merging changes into prod triggers the production deployment.
A typical development cycle looks like this:
- Start from the latest
mainbranch. - Create a branch for your change.
- Implement the change.
- Test the change locally.
- Run the project's checks.
- Commit your changes.
- Open a Pull Request targeting
main. - Review and address feedback.
- Merge the Pull Request into
main. - Once the changes are ready for production, merge them into
prod.
For larger changes, use a dedicated branch instead of working directly on main.
Example:
git checkout main
git pull
git checkout -b feature/exampleUse descriptive branch names such as:
feature/project-page
fix/navbar-mobile
refactor/api-client
docs/contributing
Keep commits focused on a single change whenever possible.
Good examples:
Add project card component
Fix mobile navigation
Improve project page layout
Update documentation
Avoid vague commit messages such as:
changes
update
stuff
fix
Pull Requests should:
- Clearly describe the changes.
- Explain why the changes were made when necessary.
- Include relevant screenshots for UI changes.
- Keep unrelated changes out of the PR.
- Be tested before submission.
Before submitting a Pull Request, make sure the application:
- Starts successfully.
- Builds successfully.
- Has no obvious runtime errors.
- Works correctly on the affected pages.
- Maintains the existing UI and functionality.
Run the project's available checks before submitting your changes.
Changes should not be pushed directly to the production branch unless they are intentionally being released.
The general release flow is:
Development
↓
main
↓
Testing & Review
↓
prod
↓
Production Deployment
- Do not commit secrets or credentials.
- Do not commit generated dependencies such as
node_modules. - Avoid force-pushing shared branches.
- Keep changes focused and reviewable.
- Test changes before merging.
- Follow the existing project conventions.
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.