Visit Sakai Vue website for a live preview.
Sakai is an application template for Vue based on the Vue CLI that provides out-of-the-box standard tooling for Vue projects. To get started, clone this repository from GitHub and install the dependencies with npm or yarn.
npm install
or
yarn install
Next step is running the application using the serve script and navigate to http://localhost:3000/ to view the application. That is it, you may now start with the development of your application using the Sakai template.
npm run dev
or
yarn dev
Following commands are derived from create app.
"npm run dev": Starts the development server
"npm run build": Builds the application for deployment.
"npm run generate": Builds the application for static deployment.
"npm run start": Runs the production server.
Sakai consists of 2 main parts; the application layout and the resources. app.vue inside src folder is the main component containing the template for the base layout whereas required resources such as SASS structure for the layout are placed inside the src/assets/ folder.
Main layout is the template of the app.vue, it is divided into a couple of child components such as topbar, menu and footer. Here is template of the app.vue component that implements the logic such as menu state, layout modes and so on.
Menu is a separate component defined in AppMenu.vue file based on PrimeVue MenuModel API. In order to define the menuitems, navigate to data section of app.vue file and define your own model as a nested structure using the menu property.
Dependencies of Sakai are listed below and needs to be added to package.json.
{
"primevue": "~3.7.1",
"primeicons": "~4.1.0",
"primeflex": "~3.0.0"
}Sakai uses the free Saga, Arya and Vela themes which are distributed within PrimeVue, however it can be used with any PrimeVue theme as well such as material, tailwind and bootstrap as layout colors are derived from the theme used via CSS variables.
In case you'd like to customize the layout variables, open _variables.scss file under src/layout folder. The list is pretty short as majority of the variables are derived from the PrimeVue theme being used.
src/assets/_variables.scss
$fontSize: 1rem;
$borderRadius: 12px;
$transitionDuration: .2s;
$maskBg: rgba(0, 0, 0, 0.4);