Vulk Documentation

First of all, Thank you so much for purchasing this template and for being our valued customer. You are awesome! You are entitled to get free lifetime updates to this product and support from the CSS Ninja team directly. Vulk is a product built by CSS Ninja and Digisquad.

This documentation has been written to help you regarding each step of setup and customization. Please go through the documentation carefully to understand how this template is made and how to edit this properly. HTML CSS, and Vue JS framework knowledge is required to customize this template.

You are currently reading the Vulk v2.0.1 documentation. The product uses:

• Vue.js (v3.3+) Composition API
• Typescript (v5+) out of the box, for large-scale JavaScript applications for any browser
• Lightning-fast vitejs (v5+) build & development tool
• Node.js (v18+) development environment
• Latest bulma (v0.9.4+) integration with sass and bulma-css-vars
• Production ready docker images based on Bitnami
• eslint, stylelint and prettier pre-configured

What's inside the release?

The Vulk release contains two projects:

• template: contains the full source code of the template which runs the https://vulk.cssninja.io/ demo
• quickstarter: contains the source code of a smaller project which you can use to start your own project, it include only the necessary files to get started with Vulk

release-vulk-v2.0.1.zip
├── template-vulk-v2.0.1.zip
└── quickstarter-vulk-v2.0.1.zip

Prerequisites

1. A good code editor
   VSCode settings are pre-configured
2. A supported web browser (Chrome, Edge, Firefox, ...)
3. Node.js LTS(> 18.x) installed
4. Familiarity with the command line
5. Knowledge with Typescript(> 5.x) (should not be installed globally)

Install Node.js

First, check if you already have Node.js and npm installed. To check if you have Node.js installed, run this command in your terminal:

node -v

If Node.js 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

TIP

You can also use Node Version Manager, or Volta.sh to manage multiple Node.js versions on your machine.

Enable pnpm with corepack

We recommend pnpm, which can be enabled with:

corepack enable
corepack prepare pnpm@latest --activate

Corepack is a script that acts as a bridge between Node.js projects and the package managers they are intended to be used with during development.
In practical terms, Corepack will let you use Yarn and pnpm without having to install them - just like what currently happens with npm, which is shipped in Node.js by default.

TIP

Corepack is installed with Node.js from v16.9.x.
If your version is below, install it with: npm install -g corepack

Support

If you have any trouble while editing this template or if you simply want to ask a question about something, feel free to post your request on our support at cssninja.io/faq/support

You can find the changelog here and inside the Vulk source folder or you can check the changelog on the theme's sale page.

Once again, thank you so much for purchasing this theme. As I said at the beginning, we'd be glad to help you if you have any questions related to this theme. No guarantees, but we'll do our best to assist and support you. If you have a more general question relating to Vulk, you might consider opening a ticket and ask your question in the CSS Ninja support portal.