This project is designed as part of the national Iranian metaverse known as MetaRang. The goal of this project is to develop a frontend platform that provides users with access to the features of the Iranian national metaverse through an optimized and user-friendly interface. This project is a part of the Behesht Supply Chain and aims to create a unique and innovative user experience for users in virtual and parallel worlds.
First, you need to clone the repository to your system. Run the following command in your terminal:
git clone https://github.com/iranpsc/Metaverse-Rang-Front-NextJS.gitOnce you have cloned the repository, navigate to the project directory:
cd Metaverse-Rang-Front-NextJSTo install the required dependencies, use the following commands:
npm installTo start the project, use the following command based on your development environment:
- Development mode:
npm run devThis will run the development server on port 5175.
- Production mode:
npm run build
npm run startThe production server will also run on port 5175.
Instead of accessing the default address http://localhost:3000, you need to navigate to the following URLs to access the pages:
- English version:
http://localhost:5175/en
- Persian version:
http://localhost:5175/fa
Phase 1 test infrastructure uses Vitest, MSW, and Playwright. For the isolated setup, copy .env.example to .env.local and use mock/local credentials only; never use production secrets in tests or disposable sandboxes.
Common test commands:
npm run test:unit
npm run test:integration
npm run test:coverage
npm run build
npm run test:e2e:core
npm run test:ui
npm run test:forms
npm run test:seo
npm run test:securityThe complete setup, environment variables, and command reference are documented in Phase 1 environment and execution.
Phase 1 reference documents:
- Repository and test-infrastructure audit
- 44-endpoint Go API contract inventory
- MSW setup and scoped coverage results
- Jules / disposable sandbox instructions
Coverage percentages refer only to the MSW handler file, not the entire application. The current SEO crawl reports existing page metadata length failures; see the MSW setup report for the verified run and scope notes.
We welcome your contributions to improve the project. To contribute to the project, follow these steps:
-
Fork the Project: Fork the repository and work on your own copy.
-
Create a New Branch: For each feature or change, create a separate branch:
git checkout -b feature-name
-
Regular Commits: Save your changes with detailed and meaningful commit messages:
git commit -m "Complete explanation of the change" -
Submit a Pull Request: After making changes and ensuring everything works properly, submit a pull request for review.
For project developers, the following guidelines must be followed:
- Use Separate Branches: Each new feature or bug fix must be implemented in a separate branch. The branch name should correspond to the change (e.g.,
feature-branch). - Regular and Clear Commits: Changes should be saved as regular commits with clear, descriptive messages.
- Review and Approval: Before merging any pull request, it must be reviewed by the development team.
- Adherence to Coding Standards: Use linting tools like ESLint to maintain code quality and follow project standards.
- Code Cleanup: Before submitting a pull request, ensure that no unnecessary or test code remains in the project.
If you encounter any problems or have any questions, feel free to contact us through the Issues section on GitHub and submit bug reports or requests.