- Introduction
- Installation
- Running the Project
- Contribution
- Development Rules
- Code Quality and Security Checks
- FAQ
This project is designed as part of the national Iranian metaverse known as MetaRang. The goal 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 part of the Behesht Supply Chain and aims to create a unique and innovative user experience in virtual and parallel worlds.
First, clone the repository to your system:
git clone https://github.com/iranpsc/Metaverse-Rang-Front-React.gitcd Metaverse-Rang-Front-Reactnpm installTo start the project in development mode:
npm run devWe welcome contributions that improve the project. Please follow these steps:
-
Fork the Project: Fork the repository and work on your own copy.
-
Create a New Branch: Create a separate branch for each feature or bug fix:
git checkout -b feature-name
-
Regular Commits: Use clear, descriptive commit messages:
git commit -m "Complete explanation of the change" -
Submit a Pull Request: Submit a pull request for review after checking your changes and following the project quality requirements.
All contributors are expected to follow these guidelines:
- Use Separate Branches: Implement each feature or bug fix in a separate branch. The branch name should describe the change (for example,
feature-branch). - Regular and Clear Commits: Keep commits focused and use descriptive messages.
- Review and Approval: Pull requests must be reviewed by the development team before merging.
- Adherence to Coding Standards: Follow the project's configured linting and code-quality rules.
- Code Cleanup: Do not leave unnecessary, temporary, or test-only code in the project.
Every pull request targeting main is checked by the automated Code Quality GitHub Actions workflow. It runs seven independent jobs: ESLint, Knip, jscpd, Semgrep, production build, Gitleaks, and OSV-Scanner. A failure in one job does not stop the others, but all required jobs must pass for the workflow to pass.
See CODE_QUALITY.md for the complete contributor guide, including each scanner's scope, exact CI command and thresholds, pass/fail criteria, how to interpret findings, local execution instructions, and remediation guidance.
If you encounter any problems or have questions, open an issue in the repository's GitHub Issues section and include the relevant error details.