Sample Vue 3 project

This guide will help you run a sample Vue 3 project from GitHub. It is a ready-to-use application with several live Flexmonster demos. Get the sample project to try out Flexmonster.

To integrate Flexmonster into an existing Vue project, see integration with Vue 3.

Prerequisites

Node.js 20.19 or later
Flexmonster CLI
Install it with the following command:
```
npm install -g flexmonster-cli
```

Step 1. Get the sample Vue 3 project

Download the sample project with the flexmonster create command. You can choose an ES6-based or TypeScript-based project:

ES6

flexmonster create vue 3 es6 -r

This command downloads the Vue 3 + ES6 project from GitHub and launches it in the browser. To shut down the project from the console, press Ctrl + C (Control + C on macOS).

The sample project is located inside the flexmonster-vue-3-es6-project/ folder in your current working directory.

TypeScript

flexmonster create vue 3 typescript -r

This command downloads the Vue 3 + TypeScript project from GitHub and launches it in the browser. To shut down the project from the console, press Ctrl + C (Control + C on macOS).

The sample project is located inside the flexmonster-vue-3-typescript-project/ folder in your current working directory.

Step 2. Check out the project’s structure

Our sample project was created using Vite, so most of the project’s files are typical of Vite-based projects.

Now take a look at the files specific to our sample project:

src/router/index.js (index.ts in TypeScript) — route definitions for the sample project.
src/components/UIElements/ — menus and toggle elements used in the sample project.
src/views/VueFlexmonsterExamples/ — demos that cover different aspects of Flexmonster usage in Vue:
- Creating the pivot table (PivotTableDemo.vue)
- Creating the pivot table using Options API (OptionsAPIDemo.vue)
- Handling events (HandlingEvents.vue)
- Using API calls (UsingAPICalls.vue)
- Updating data at runtime (UpdatingData.vue)
- Customizing the Toolbar (CustomizingToolbar.vue)
- Customizing the grid (CustomizingGrid.vue)
- Integrating with Highcharts (WithHighcharts.vue)
- Integrating with amCharts (WithAmcharts.vue — amCharts 5; WithAmcharts4.vue — amCharts 4)

Learn more about how these demos work: Usage examples.

Next steps

Integrate into an existing Vue 3 project or adjust the sample project to your needs: