# vuero > ## ▶️ Getting started Latest version **2.2.0** (published 2022-03-11) · SEE LICENSE IN LICENSE.md license · 0 weekly downloads ## Install ```sh npm install vuero pnpm add vuero yarn add vuero bun add vuero ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; large bundle. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.2.0 | | Published | 2022-03-11 | | First published | 2022-03-11 | | Weekly downloads | 0 | | License | SEE LICENSE IN LICENSE.md | | TypeScript types | none | | Module format | CommonJS | | Node | >=14.17.0 | | Dependencies | 51 | | Unpacked size | 81.3 MB | | Known vulnerabilities | 0 (+27 in 3 direct dependencies) | | Install scripts | no | | Author | cssninjaStudio | | Maintainers | absidish | ## Links - npm: https://www.npmjs.com/package/vuero - npm.io page: https://npm.io/package/vuero ## Dependencies (51) - [vue](https://npm.io/package/vue.md) 3.2.26 - [yup](https://npm.io/package/yup.md) 0.32.11 - [vuex](https://npm.io/package/vuex.md) ^4.0.2 - [axios](https://npm.io/package/axios.md) ^0.24.0 - [bulma](https://npm.io/package/bulma.md) 0.9.3 - [dayjs](https://npm.io/package/dayjs.md) 1.10.7 - [imask](https://npm.io/package/imask.md) 6.2.2 - [notyf](https://npm.io/package/notyf.md) 3.10.0 - [pinia](https://npm.io/package/pinia.md) 2.0.9 - [tslib](https://npm.io/package/tslib.md) 2.3.1 - [vivus](https://npm.io/package/vivus.md) 0.4.6 - [dragula](https://npm.io/package/dragula.md) 3.7.3 - [dropzone](https://npm.io/package/dropzone.md) 6.0.0-beta.2 - [filepond](https://npm.io/package/filepond.md) 4.30.3 - [tippy.js](https://npm.io/package/tippy.js.md) 6.3.7 - [vue-i18n](https://npm.io/package/vue-i18n.md) 9.2.0-beta.26 - [mapbox-gl](https://npm.io/package/mapbox-gl.md) 2.6.1 - [nprogress](https://npm.io/package/nprogress.md) 0.2.0 - [simplebar](https://npm.io/package/simplebar.md) 6.0.0-beta.10 - [vue-tippy](https://npm.io/package/vue-tippy.md) 6.0.0-alpha.43 - [apexcharts](https://npm.io/package/apexcharts.md) 3.32.1 - [photoswipe](https://npm.io/package/photoswipe.md) 4.1.3 - [v-calendar](https://npm.io/package/v-calendar.md) 3.0.0-alpha.6 - [vue-router](https://npm.io/package/vue-router.md) 4.0.12 - [tiny-slider](https://npm.io/package/tiny-slider.md) 2.9.4 - [@vueuse/core](https://npm.io/package/@vueuse/core.md) 7.5.1 - [@vueuse/head](https://npm.io/package/@vueuse/head.md) 0.7.4 - [billboard.js](https://npm.io/package/billboard.js.md) 3.2.2 - [vee-validate](https://npm.io/package/vee-validate.md) 4.5.6 - [vue-scrollto](https://npm.io/package/vue-scrollto.md) 2.20.0 - [simplebar-vue](https://npm.io/package/simplebar-vue.md) 2.0.0-beta.10 - [@popperjs/core](https://npm.io/package/@popperjs/core.md) 2.11.0 - [bulma-css-vars](https://npm.io/package/bulma-css-vars.md) 0.7.0 - [@vueform/slider](https://npm.io/package/@vueform/slider.md) 2.0.8 - [vue3-apexcharts](https://npm.io/package/vue3-apexcharts.md) 1.4.1 - [@iconify/iconify](https://npm.io/package/@iconify/iconify.md) 2.1.0 - [markdown-it-emoji](https://npm.io/package/markdown-it-emoji.md) 2.0.0 - [simple-datatables](https://npm.io/package/simple-datatables.md) 3.2.0 - [@vueform/multiselect](https://npm.io/package/@vueform/multiselect.md) 2.3.1 - [@ckeditor/ckeditor5-vue](https://npm.io/package/@ckeditor/ckeditor5-vue.md) 2.0.1 - [@mapbox/mapbox-gl-geocoder](https://npm.io/package/@mapbox/mapbox-gl-geocoder.md) 4.7.4 - [filepond-plugin-image-crop](https://npm.io/package/filepond-plugin-image-crop.md) 2.0.6 - [filepond-plugin-image-edit](https://npm.io/package/filepond-plugin-image-edit.md) 1.6.3 - [vue-accessible-color-picker](https://npm.io/package/vue-accessible-color-picker.md) 3.2.0 - [filepond-plugin-image-resize](https://npm.io/package/filepond-plugin-image-resize.md) 2.0.10 - [filepond-plugin-image-preview](https://npm.io/package/filepond-plugin-image-preview.md) 4.6.10 - [filepond-plugin-image-transform](https://npm.io/package/filepond-plugin-image-transform.md) 3.8.7 - [@ckeditor/ckeditor5-build-classic](https://npm.io/package/@ckeditor/ckeditor5-build-classic.md) 31.1.0 - [filepond-plugin-file-validate-size](https://npm.io/package/filepond-plugin-file-validate-size.md) 2.2.5 - [filepond-plugin-file-validate-type](https://npm.io/package/filepond-plugin-file-validate-type.md) 1.2.6 - [filepond-plugin-image-exif-orientation](https://npm.io/package/filepond-plugin-image-exif-orientation.md) 1.0.11 ## Recent versions - 2.2.0 (latest) — 2022-03-11 ## README # Vuero Vue3 - Multipurpose Admin and Webapp Template ## ▶️ Getting started First of all, Thank you so much for purchasing this template and for being our loyal customer. You are awesome! You are entitled to get free lifetime updates to this product and support from the cssninjaStudio team directly. **Vuero** is a product built by [cssninjaStudio](https://cssninja.io/) and [Digisquad](https://digisquad.io/). ### Prerequisites 1. A recent web browser (Chrome, Edge, Firefox, ...) 2. [Nodejs LTS](https://nodejs.org/en/) _(> 14.x with npm >7)_ installed 3. Knowledge with [Typescript](https://github.com/microsoft/typescript) _(> 4.x)_ (should not be installed globally) 4. (recommended) [VSCode](https://code.visualstudio.com/ with [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) #### Install nodejs First, check if you already have node and npm installed. To check if you have Node.js installed, run this command in your terminal: ```bash node -v ``` To confirm that you have npm installed you can run this command in your terminal: ```bash npm -v ``` If node is not installed on your machine, you can go to the official nodejs.org website, and choose the version depending on your operating system: - Install node.js and npm on Windows, Linux or Mac OSX #### Check the npm version npm is a separate project from Node.js, and tends to update more frequently. As a result, even if you’ve just downloaded Node.js (and therefore npm), you’ll probably need to update your npm. Luckily, npm knows how to update itself! To update your npm, type this into your terminal: ```bash npm install --global npm@latest ``` #### Installing Yarn (recommended) We personally recommend Yarn as we think it is a better package manager than npm. If you want to use Yarn, keep in mind that you should not mix the 2. You either use Yarn or Npm in a project, never both. ```bash npm install --global yarn ``` ## 📦 Dependencies installation To setup the template and start installing project dependencies, run one of the following commands: ```bash # using npm v7 npm install --legacy-peer-deps # using yarn yarn install ``` ## 🔃 Run a development server To start the development server, run one of the following commands: ```bash # using npm v7 npm run dev # using yarn yarn dev ``` This will run the `dev` script from the `package.json` file. You will notice that two servers are started: one for the frontend (vite) and one for the backend (json-server). Vite is the build tool that we use to compile the frontend code. It replace webpack and vue-cli, used in vue 2 ecosystem. You can only start vite with `dev:vite` Read more about it [on vitejs.dev](https://vitejs.dev/) Json-server is a fake REST-API server that we use to simulate the backend. The configuration and the database are in the `/json-server` directory. You can find how we use it in the `/src/pages/messaging-v1.vue` file and the `/src/composable/useChatApi.ts` You can only start vite with `dev:json-server` Read more about it [on github.com/typicode/json-server](https://github.com/typicode/json-server) > - Access the Vuero frontend in your browser at [http://localhost:3000/](http://localhost:3000/) > - Access the Json-server backend in your browser at [http://localhost:8080/](http://localhost:8080/) ## 💡 What to do next ? Our online documentation is a great place to learn how to use Vuero. We try to keep it mostly up to date, so you can always find the latest information. > We also have a great [discord community](https://discord.cssninja.io/) where you can ask questions and show your work. ### [Vuero on docs.cssninja.io](https://docs.cssninja.io/vuero?utm_source=readme) - [Setup your project](https://docs.cssninja.io/vuero/documentation/setup-your-project.html?utm_source=readme) - [Customizing Vuero](https://docs.cssninja.io/vuero/documentation/customizing-vuero.html?utm_source=readme) - [Going further](https://docs.cssninja.io/vuero/documentation/going-further.html?utm_source=readme) - [Common Issues](https://docs.cssninja.io/vuero/documentation/common-issues.html?utm_source=readme) - [Customer support](https://docs.cssninja.io/vuero/documentation/customer-support.html?utm_source=readme) - [Changelog](https://docs.cssninja.io/vuero/documentation/changelog.html?utm_source=readme) ### [cssninjaStudio on youtube.com](https://www.youtube.com/channel/UCySf97KnXg9IvVeSeEvF-wQ) - [Cleaning the project and getting started](https://www.youtube.com/watch?v=lE5VNpP8JqA) We try to keep Vuero dependencies and best practices up to dates. We also take care of user requests, either by implementing requested features, fixing bugs or improving the documentation. If you want to contribute, feel free to create or up-vote discussions on the dedicated [public github repository](https://github.com/cssninjaStudio/vuero-public/discussions). You can also have access to the private github access, so you can view the source code history and submit issues. To do so, open a ticket on the [support portal](https://support.cssninja.io) with your github username. ### Useful links - http://v3.vuejs.org/ - https://v3.vuejs.org/guide/composition-api-introduction.html - https://v3.vuejs.org/api/composition-api.html - https://v3.vuejs.org/api/sfc-script-setup.html - https://v3.vuejs.org/guide/typescript-support.html - https://vitejs.dev/ - https://pinia.esm.dev/ - https://vueuse.org/ --- _Source: https://npm.io/package/vuero · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._