MetaRang Frontend Project

Table of Contents

• Introduction
• Installation
• Running the Project
• Contribution
• Development Rules
• FAQ

Introduction

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.

Installation

1. Clone the Repository

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.git

2. Navigate to the Project Directory

Once you have cloned the repository, navigate to the project directory:

cd Metaverse-Rang-Front-NextJS

3. Install Dependencies

To install the required dependencies, use the following commands:

npm install

Running the Project

4. Run the Project

To start the project, use the following command based on your development environment:

• Development mode:

npm run dev

This will run the development server on port 5175.

• Production mode:

npm run build
npm run start

The production server will also run on port 5175.

5. View the Project in the Browser

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

Contribution

We welcome your contributions to improve the project. To contribute to the project, follow these steps:

1. Fork the Project: Fork the repository and work on your own copy.

2. Create a New Branch: For each feature or change, create a separate branch:

   git checkout -b feature-name

3. Regular Commits: Save your changes with detailed and meaningful commit messages:

   git commit -m "Complete explanation of the change"

4. Submit a Pull Request: After making changes and ensuring everything works properly, submit a pull request for review.

Development Rules

For project developers, the following guidelines must be followed:

1. 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).
2. Regular and Clear Commits: Changes should be saved as regular commits with clear, descriptive messages.
3. Review and Approval: Before merging any pull request, it must be reviewed by the development team.
4. Adherence to Coding Standards: Use linting tools like ESLint to maintain code quality and follow project standards.
5. Code Cleanup: Before submitting a pull request, ensure that no unnecessary or test code remains in the project.

FAQ

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.