add items to public release

actions-user · actions-user · commit d227a1243602 · 2024-09-25T16:30:30.000+03:30
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,24 @@
+
+# Issue Report
+
+### Description
+
+[Provide a brief description of the issue.]
+
+### Steps to Reproduce
+
+1. [First step]
+2. [Second step]
+3. [Third step]
+
+### Expected Behavior
+
+[Explain what you expected to happen.]
+
+### Actual Behavior
+
+[Explain what actually happened.]
+
+### Additional Information
+
+[Include any additional information such as screenshots, logs, etc.]
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,75 @@
+name: CI/CD for MetaRang Frontend
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout repository
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Set up Node.js
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16.x"
+
+      # Install dependencies
+      - name: Install dependencies
+        run: npm install
+
+      # Set Git user for commits
+      - name: Configure Git user
+        run: |
+          git config --global user.name "Awmin"
+          git config --global user.email "awmin.dn@gmail.com"
+
+      # Run standard-version to bump version, generate changelog, and tag the release
+      - name: Bump version using standard-version
+        run: |
+          npx standard-version
+
+      # Push changes including version bump and changelog
+      - name: Push changes
+        run: |
+          git push --follow-tags origin main
+
+      # Build the project
+      - name: Build the project
+        run: npm run build
+
+
+  release:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the code again
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # Generate tag name based on updated version from package.json
+      - name: Generate tag name from package.json
+        id: generate_tag
+        run: |
+          VERSION=$(jq -r ".version" package.json)
+          echo "TAG_NAME=v$VERSION" >> $GITHUB_ENV
+
+      # Create GitHub Release
+      - name: Create GitHub Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ env.TAG_NAME }}
+          release_name: "Release ${{ env.TAG_NAME }}"
+          body: ${{ github.event.head_commit.message }} # استفاده از متن کامیت
+          draft: false
+          prerelease: false
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,96 @@
+
+# Contributing to MetaRang Frontend Project
+
+Thank you for considering contributing to the MetaRang Frontend Project! We welcome contributions of all kinds, from bug reports and suggestions to code contributions and documentation improvements.
+
+## Getting Started
+
+Follow the steps below to clone the repository and start working on it.
+
+### 1. Clone the Repository
+
+To start working on the project, clone the repository to your local machine:
+
+```bash
+git clone https://github.com/iranpsc/Metaverse-Rang-Front-NextJS.git
+```
+
+### 2. Navigate to the Project Directory
+
+Once the repository is cloned, navigate to the project directory:
+
+```bash
+cd Metaverse-Rang-Front-NextJS
+```
+
+### 3. Install Dependencies
+
+Before running the project, make sure to install all the required dependencies:
+
+```bash
+npm install
+```
+
+### 4. Run the Project
+
+Start the development server on port 5175:
+
+```bash
+npm run dev
+```
+
+You can now access the project at `http://localhost:5175`.
+
+## Coding Standards
+
+Please adhere to the following coding standards to ensure consistency and quality across the codebase:
+
+- **Indentation**: Use 2 spaces for indentation.
+- **Comments**: Comment your code where necessary to explain complex logic.
+- **Variable Naming**: Use meaningful and descriptive variable names written in camelCase.
+- **Commit Messages**: Write clear and concise commit messages that describe the changes made.
+- **Testing**: Ensure that all new features and bug fixes are thoroughly tested.
+
+## Pull Request Process
+
+To submit a pull request, follow the steps below:
+
+### 1. Create a New Branch
+
+When working on a new feature or bug fix, create a new branch from the `main` branch:
+
+```bash
+git checkout -b feature-or-bugfix-name
+```
+
+### 2. Make Your Changes
+
+Make your changes on this branch and test thoroughly.
+
+### 3. Commit Your Changes
+
+Once your changes are ready, commit them with a meaningful message:
+
+```bash
+git commit -m "A clear and concise description of the changes"
+```
+
+### 4. Push the Branch
+
+Push your branch to your fork of the repository:
+
+```bash
+git push origin feature-or-bugfix-name
+```
+
+### 5. Open a Pull Request
+
+Navigate to the GitHub repository and open a pull request from your branch to the `main` branch. In your pull request description, provide a detailed explanation of the changes and any relevant information.
+
+## Merge Process
+
+- All pull requests must be reviewed and approved by at least one other contributor before they can be merged.
+- Ensure that your code passes all tests and linting checks before requesting a review.
+- After approval, a maintainer will merge the pull request into the `main` branch.
+
+Thank you for following the contribution guidelines and helping improve MetaRang Frontend Project!
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Paradise Supply Chain Cooperative Company
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,22 @@
+
+
+# Pull Request Review and Merge Guidelines
+
+## Pull Request Review Process
+
+1. All pull requests must be reviewed by **at least two developers** before being merged into the `main` branch.
+2. Reviewers should ensure:
+   - The code follows the project's coding standards.
+   - The functionality introduced by the pull request is working as expected.
+   - There are no conflicts with the `main` branch.
+3. Any required changes or improvements should be communicated via the pull request comments.
+4. Once the pull request has been approved by two reviewers, it can be merged by one of the maintainers.
+
+## Conflict Resolution
+
+If there are conflicts with the `main` branch, the author of the pull request must resolve them before the pull request can be merged.
+
+## Tests and Documentation
+
+- Ensure all tests are passing before submitting a pull request.
+- If the pull request introduces new functionality, make sure to update or add any necessary documentation.
diff --git a/README.md b/README.md
@@ -1,38 +1,113 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
-## Getting Started
+# MetaRang Frontend Project
 
-First, run the development server:
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Running the Project](#running-the-project)
+- [Contribution](#contribution)
+- [Development Rules](#development-rules)
+- [FAQ](#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:
+
+```bash
+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:
+
+```bash
+cd Metaverse-Rang-Front-NextJS
+```
+
+### 3. Install Dependencies
+
+To install the required dependencies, use the following commands:
+
+```bash
+npm install
+```
+
+## Running the Project
+
+### 4. Run the Project
+
+To start the project, use the following command based on your development environment:
+
+- **Development mode:**
 
 ```bash
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+This will run the development server on port `5175`.
+
+- **Production mode:**
+
+```bash
+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
 
-You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+We welcome your contributions to improve the project. To contribute to the project, follow these steps:
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
+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:
 
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+   ```bash
+   git checkout -b feature-name
+   ```
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+3. **Regular Commits:** Save your changes with detailed and meaningful commit messages:
 
-## Learn More
+   ```bash
+   git commit -m "Complete explanation of the change"
+   ```
 
-To learn more about Next.js, take a look at the following resources:
+4. **Submit a Pull Request:** After making changes and ensuring everything works properly, submit a pull request for review.
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+## Development Rules
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+For project developers, the following guidelines must be followed:
 
-## Deploy on Vercel
+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.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## FAQ
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+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.
diff --git a/package.json b/package.json
