Getting Started

Setup Skote - HTML

We are using gulp which allows having complete automation for build flow. In case if you don't know Gulp then it's easy to use it. Gulp is a toolkit for automating painful or time-consuming tasks in the development workflow, so you can stop messing around while building any project. You can read it more about it here. Please follow below steps to install and setup all prerequisites:

Prerequisites

Please follow below steps to install and setup all prerequisites:

  • Yarn

    Make sure to have the Yarn installed & running in your computer. If you already have installed Yarn on your computer, you can skip this step. We suggest you to use Yarn instead of NPM.

  • Nodejs

    Make sure to have the Node.js installed & running in your computer. If you already have installed Node on your computer, you can skip this step if your existing node version is greater than 18.

  • Gulp

    Make sure to have the Gulp installed & running in your computer. If you already have installed gulp on run command npm install -g gulp from your terminal.

  • Git

    Make sure to have the Git installed globally & running on your computer. If you already have installed git on your computer, you can skip this step.

Installation:

To setup the admin theme, follow below-mentioned steps:

  • Install Prerequisites

    Make sure to have all above prerequisites installed & running on your computer

After you finished with the above steps, you can run the following commands into the terminal / command prompt from the root directory of the project to run the project locally or build for production use:

This would install all the required dependencies in the node_modules folder.

yarn install

Runs the project locally, starts the development server and watches for any changes in your code, including your HTML, javascript, sass, etc. The development server is accessible at http://localhost:3000.

gulp

Generates a /dist directory with all the production files. 

gulp build

Setup Skote - Laravel

Laravel Vite provides a clean, fluent API for defining basic build steps for your Laravel application. Mix supports several common CSS and JavaScript pre-processors.

Prerequisites

Please follow below steps to install and setup all prerequisites:

  • Server
    Make sure to have the Xampp/Wampp installed & running in your computer. If you already have installed Xampp/Wampp on your computer, you can skip this step.
    Note: PHP Version must be greater than 8.0.

  • Composer

    Make sure to have the Composer installed & running in your computer.

  • Nodejs

    Make sure to have the Node.js installed & running in your computer. If you already have installed Node on your computer, you can skip this step if your existing node version is greater than 14.

  • Git

    Make sure to have the Git installed globally & running on your computer. If you already have installed git on your computer, you can skip this step.

Installation:

To setup the admin theme, follow below-mentioned steps:

  • Install Prerequisites

    Make sure to have all above prerequisites installed & running on your computer

After you finished with the above steps, you can run the following commands to run the project locally or build for production use:

This would install all the required packages in the vendor folder.
If you getting any error when running composer install command, don't worry please continue with : composer update 

npm install  
composer install

Please run the below command to generate the new key. 
php artisan key:generate
Please fill your DB credentials in the .env file and make sure you have created database with name "skote".
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=skote
DB_USERNAME=root
DB_PASSWORD=

Please fill your Email credentials in the .env file.
MAIL_MAILER=
MAIL_HOST=
MAIL_PORT=
MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_ENCRYPTION=
MAIL_FROM_ADDRESS=
MAIL_FROM_NAME="${APP_NAME}"

If you don't have an credentials for email you can create it from Google Developer Console or you can use Mailtrap or any other, it's mandatory for forget password or other mail functionality.

To compile all CSS and will copy all images, Js, Libs into the public directory. Run this command to get minify output for the production server. 

npm run build

To Generate RTL CSS From LTR CSS. 

npm run build-rtl

This will migrate the database tables. For more details visit https://laravel.com/docs/10.x/migrations 

php artisan migrate

This will seed the database records. For more details visit https://laravel.com/docs/10.x/seeding 

php artisan db:seed

The development server is accessible at http://localhost:8000.To run on other port just run command : php artisan serve --port=8001

php artisan serve
© Skote.