Installation

From Github Repository (workspace)

The Vuero repository is a pnpm workspace containing all the quickstarters and the template source code.

packages/
├─ app/
├─ app-ssr/
├─ app-electron/
├─ app-nuxt/
└─ demo/
package.json
pnpm-workspace.yaml

1. Clone the repository:

git clone git@github.com:cssninjaStudio/vuero.git

INFO

Unlock your access: https://cssninja.io/faq/github-access

2. Install the dependencies:

pnpm install # pnpm is required in the repository

3. Run a command in a package:

pnpm --filter=demo ssr:dev

This run the ssr:dev script defined in packages/demo/package.json.

4. Install a dependency in a package:

pnpm --filter=demo add -D my-dependency

TIP

You can copy any packages, like packages/app, to a new folder and start your project from there by following the instructions below.

From ThemeForest, Css Ninja, or Github Releases

Extract the source code

1. Extract the content of a quickstarter in your project folder:

app

unzip vuero-app-v3.0.0.zip -d <my-vuero-project>

app-ssr

unzip vuero-app-ssr-v3.0.0.zip -d <my-vuero-project>

app-electron

unzip vuero-app-electron-v3.0.0.zip -d <my-vuero-project>

app-nuxt

unzip vuero-app-nuxt-v3.0.0.zip -d <my-vuero-project>

demo

unzip vuero-demo-v3.0.0.zip -d <my-vuero-project>

2. Install the dependencies:

pnpm install # or bun install, npm install, yarn install

Initialize git repository

We recommend to initialize a new git repository for your project and create your first commit at this point.

git init
git add .
git commit -m "feat: init vuero v3.0.0"

WARNING

Remember to make your repository private if you fork or create a new git repository, as the template is a paid product.

Start the development server

pnpm dev # or bun dev, npm run dev, yarn dev

INFO

Take a look at the README.md and package.json file, you will see details about each command available in the project.

You can now access the Vuero frontend in your browser at http://localhost:3000/ and start customizing your project.

When using SPA mode, development server is directly provided by Vite. When using SSR mode, the development server is custom and use Vite as a middleware, learn more about in SSR Guide.