From 486cb1e81e16ff47156c1df1fae2a5608d123c29 Mon Sep 17 00:00:00 2001 From: bereket Date: Thu, 10 Jul 2025 17:15:01 +0300 Subject: [PATCH] [ADD] local installation commands --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d645eb0..8bff7b8a 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,34 @@ module.exports = { }; ``` + + + + +Run locally +If you want to work on the library itself or preview the documentation on your machine, follow these steps: + +# 1. Clone the repository +git clone https://github.com/themesberg/flowbite-vue.git +cd flowbite-vue + +# 2. Install dependencies (requires Node.js 18+ and npm 10+) +npm install + +# 3. Start the VitePress development server +npm run dev +After the server starts, open the URL shown in the terminal (usually http://localhost:5173) to view the documentation site. + +Common additional commands: + +Purpose Command +Build documentation site npm run build +Run unit tests npm run test +Lint and fix files npm run lint-fix +Clear build and cache artifacts npm run clear + + + ## Components @@ -382,4 +410,4 @@ If you need the Figma files for the components you can check out our website for The Flowbite name and logos are trademarks of Crafty Dwarf Inc. -📝 [Read about the licensing terms](https://flowbite.com/getting-started/license/) +📝 [Read about the licensing terms](https://flowbite.com/getting-started/license/) \ No newline at end of file