✨ Vue CMS ✨

The boilerplate of Vue v3, Typescript, Vite, Vue Router, Pinia, Axios, Tailwind CSS, and Vue i18n for buildings efficient, faster, maintainable, and scalable for enterprise applications.

📚 Table of Contents

• ❓ What's Included?
• 🖇️ Core Dependencies
• 🗂️ Project Structure
• 🚀 Getting Started
  • Prerequisites
  • Installation
• 💡 Scripts
• 📝 License

❓ What's Included?

• Authentication: Provides a secure login system for users.
• Authorization: Implements role-based access control to manage user permissions.
• Multiple Language: Supports localization and enables users to switch between different languages.
• Theme (Light/Dark/System): Offers a choice of light, dark, or system-based theme for a personalized user experience.
• Form Validation: Includes form validation functionality to ensure data integrity and improve user experience.
• Error Handling: Handles and displays error messages in a user-friendly manner.
• API Integration: Integrates with external APIs to fetch data and provide dynamic content.
• Responsive Design: Ensures the application is optimized for various screen sizes and devices.
• Testing: Includes a test suite with unit tests and integration tests for reliable code quality.
• Documentation: Provides comprehensive documentation to guide developers and users.

🚀 Getting Started

Prerequisites

↑ Back to top

1. Node Js version v20.10.0. The current Long Term Support (LTS) release is an ideal starting point.

2. Visual Studio Code. Visual Studio Code is the free and open-sourced code editor. It is one of the top most editor used especially for JavaScript application development.

   Recommended Plugin for VSCode

   • TypeScript Vue Plugin (Volar)
   • Vue Language Features (Volar)
   • Tailwind CSS IntelliSense
   • Prettier - Code formatter
   • Prettier ESLint
   • Auto Rename Tag
   • Code Spell Checker
   • ESLint
   • Git Graph
   • GitLens — Git supercharged

Installation

↑ Back to top

1. Clone this repository to your computer:

   https://github.com/haofrontend-dev/BLOG_CMS_VUE?
   cd blog-cms
   code .

2. Run command below to ignore git case-sensitive filename

   git config --global core.ignorecase false

3. From the project's root directory, install the required packages (dependencies):

   yarn install

4. Create environment files:

   cp .env.example .env

5. Set up the environment variables.

6. To run the app on your local machine:

   yarn dev

7. Build for production

   yarn build

   Happy Coding :)

💡 Scripts

↑ Back to top

The following scripts are available:

Script	Action
yarn install	Installs the project dependencies.
yarn dev	Runs the application in development mode.
yarn build	Builds the production-ready optimized bundle.
yarn preview	Starts the preview server using Vite.
yarn lint	Runs ESLint to lint the project files and fix any issues.
yarn format	Formats the source code using Prettier.

📝 License

This project is licensed under the MIT License.