{"id":13677384,"url":"https://github.com/DMaiGit/rsbuild_vue3_h5_template","last_synced_at":"2025-04-29T11:30:37.772Z","repository":{"id":225794341,"uuid":"766850548","full_name":"DMaiGit/rsbuild_vue3_h5_template","owner":"DMaiGit","description":"This project is a template for Vue 3, integrated with RSBuild for development and build processes. It includes popular libraries such as Axios, Pinia, Vant, and Vue Router.","archived":false,"fork":false,"pushed_at":"2024-03-08T07:21:49.000Z","size":230,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-11T19:40:49.941Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DMaiGit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-04T08:46:08.000Z","updated_at":"2024-10-31T09:07:56.000Z","dependencies_parsed_at":"2024-03-08T08:30:42.702Z","dependency_job_id":null,"html_url":"https://github.com/DMaiGit/rsbuild_vue3_h5_template","commit_stats":null,"previous_names":["dmaigit/rsbuild_vue3_h5_template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DMaiGit%2Frsbuild_vue3_h5_template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DMaiGit%2Frsbuild_vue3_h5_template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DMaiGit%2Frsbuild_vue3_h5_template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DMaiGit%2Frsbuild_vue3_h5_template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DMaiGit","download_url":"https://codeload.github.com/DMaiGit/rsbuild_vue3_h5_template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251493667,"owners_count":21598151,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T13:00:41.303Z","updated_at":"2025-04-29T11:30:37.436Z","avatar_url":"https://github.com/DMaiGit.png","language":"TypeScript","funding_links":[],"categories":["Starter"],"sub_categories":["Rsbuild Starter"],"readme":"\u003ch1 align=\"center\"\u003e🚀 RSBuild Vue3 H5 Template 🌟\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n🛠 This Vue 3 template, integrated with RSBuild, streamlines development and build processes with popular libraries such as Axios, Pinia, Vant, and Vue Router. 📚\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"./README.md\"\u003e🇬🇧 English\u003c/a\u003e\n  \u0026nbsp;|\u0026nbsp;\n  \u003ca href=\"./README.zh-CN.md\"\u003e🇨🇳 简体中文\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## 🗂 Table of Contents\n\n- [Requirements](#-requirements)\n- [Project Structure](#-project-structure)\n- [Quick Start](#-quick-start)\n- [Features](#-features)\n\n## 📋 Requirements\n\n- **Node.js** \u003e= 20 🟢\n- **npm** \u003e= 10 📦\n- **Vue** 3 ⚡\n- **Vue Router** \u003e= 4 🚦\n- **Pinia** \u003e= 2 🌲\n- **TypeScript** \u003e= 5 📘\n- **Vant-Ui** 4 📱\n- **Axios** \u003e= 1.6 🌐\n\n\u003e **💡 Tip**: 🚀 Use PNPM to unlock RSBuild's full debug capabilities! 🛠 Without PNPM, you might miss out on `rsbuild`'s debug features.\n\n## 📁 Project Structure\n\nBelow is the tree structure of the project, providing an overview and purpose of each file and directory:\n\n```plaintext\nroot\n├── .husky/                    # Husky hooks for enforcing good commit practices\n├── .vscode/                   # VSCode specific settings\n├── dist/                      # Compiled files ready to be deployed\n├── public/                    # Public assets that will not be processed by Webpack\n│   ├── favicon.ico            # Favicon for the website\n│   └── index.html             # Entry HTML for the application\n├── src/                       # Source code of the application\n│   ├── @types/                # TypeScript typings specific to the project\n│   ├── api/                   # API service functions and setup\n│   ├── assets/                # Static assets such as images and global styles\n│   │   └── images/            # Images used within the application\n│   ├── components/            # Reusable Vue components\n│   ├── mock/                  # Mock data for testing and development\n│   ├── routes/                # Application routing definitions\n│   ├── static/                # Static files that are copied to the output directory\n│   │   └── fonts/             # Fonts used in the application\n│   ├── stores/                # Pinia stores for state management\n│   ├── styles/                # Global and modular styles\n│   ├── utils/                 # Utility and helper functions\n│   ├── views/                 # Vue components that act as pages\n│   │   └── main/              # Main views of the application\n│   ├── App.vue                # Root Vue component\n│   ├── env.d.ts               # Environment variable typings for TypeScript\n│   └── index.ts               # Main entry point for the Vue application\n├── .browserslistrc            # Browser compatibility configuration\n├── .editorconfig              # Coding style definitions for IDEs\n├── .env.development           # Environment variables for development\n├── .env.local                 # Local environment variables\n├── .env.production            # Environment variables for production\n├── .eslintrc.js               # ESLint rules and configurations\n├── .gitignore                 # Specifies files to be ignored in version control\n├── commitlint.config.js       # Configuration for commit message linting\n├── package.json               # Project metadata and dependencies\n├── postcss.config.js          # Configuration for PostCSS\n├── README.md                  # The descriptive file for the project\n├── README.zh-CN.md            # Chinese version of the README, provides project details for Chinese-speaking users.\n├── rsbuild.config.ts          # Configuration file for RSBuild, which is used to define and manage build tasks and project build settings.\n├── tailwind.config.js         # Tailwind CSS configuration file, used to customize Tailwind's default settings to match the project's design requirements.\n└── tsconfig.json              # TypeScript compiler configuration file, defines how TypeScript compiles the code.    \n```        \n\n## 🚀 Quick Start\n\n```bash\nnpm install       # 📦 Install project dependencies\nnpm run dev       # 🌈 Start the development server\nnpm run dev-debug # 🔍 Start with RSBuild debug\nnpm run build     # 🏗 Build for production\nnpm run build-debug # 🔧 Build for production with RSBuild debug\nnpm run preview   # 🎥 Preview the built project\nnpm run test      # 🧪 Run tests (not specified yet)\nnpm run prepare   # 📌 Prepare Husky\nnpm run commit    # 💬 Run Commitizen for commits\n```\n\n## ✨ Features\n  - Vue 3: Progressive JavaScript framework for UI development. 🎉\n  - Axios: Promise-based HTTP client. 🌍\n  - Pinia: State management for Vue. 🗃\n  - Vant: Mobile-first Vue UI library. 📱\n  - Vue Router: Official router for Vue.js. 🛣\n  - TypeScript: JavaScript with type safety. 📜\n  - Tailwind CSS: Utility-first CSS framework. 💅\n  - ##### 🛠 Development Tools and Libraries\n  - @commitlint/cli \u0026 @commitlint/config-conventional: Ensures commit messages follow the conventional commit format. 📝\n  - cross-env: Sets environment variables across platforms. 🌐\n  - eslint-plugin-vue \u0026 @typescript-eslint/eslint-plugin: Provides linting for Vue and TypeScript files. 🔍\n  - husky \u0026 commitizen: Manages Git hooks and commit message formats. 🐶\n  - vue-tsc \u0026 tailwindcss: Supports type checking for Vue and utility-first styling with Tailwind CSS. 🎨\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDMaiGit%2Frsbuild_vue3_h5_template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDMaiGit%2Frsbuild_vue3_h5_template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDMaiGit%2Frsbuild_vue3_h5_template/lists"}