Getting Started

Setup Skote
Prerequisites:
Suggestion: Yarn is recommended over npm.

Please follow the below steps to install and setup all prerequisites:

  • Nodejs

    Make sure to have Node.js installed & running on 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. We suggest you to use LTS version of Node.js.

  • Yarn

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

     npm install --global yarn
  • Git

    Make sure to have Git installed globally & running on your computer. If you already have installed git on your computer, you can skip this step.
    To install in Linux OS please run the below commands.

    sudo apt-get update
sudo apt-get install git

Once you've completed the preceding steps, you can execute the following commands in the terminal or command prompt from the root directory of Skote. This will either run the project locally or build it for production use:

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

yarn install  or  yarn

Runs the project locally, starts the development server and watches for any changes in your code. The development server is accessible at http://localhost:8080.

yarn serve

Generates a /build directory with all the production files.

yarn build

Note :- Make sure that you have installed Xampp, Composer, Node and Yarn / npm already.

Prerequisites

For installation and setup all prerequisites, please follow the below steps:

Xampp Make sure to have Xampp installed & running on your computer. PHP Version 8.1 or Higher must be required for Laravel 10.
Composer Make sure to have Composer installed & running on your computer. make sure the composer version must be 2.2.0 or Higher.
Nodejs Make sure to have Node.js installed & running on 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. We suggest you to use LTS version of Node.js.
Yarn Make sure to have the Yarn installed & running on your computer. If you already have installed Yarn on your computer, you can skip this step. We suggest you use Yarn instead of NPM.
Git Make sure to have Git installed globally & running on your computer. If you already have installed git on your computer, you can skip this step.

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

Command Description
yarn This would install all the required dependencies in the node_modules folder.
composer install command to install all of the framework's dependencies.
Please run the below command to generate the new key. 
php artisan key:generate
Please fill your DB credentials in the .env file.
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=steex_laravel
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 or you can use Mailtrap or any other, it's mandatory for forget password or other mail functionality.

By yarn :
yarn run build To compile all scss to css and copy all files from resource to public directory.
yarn run build-rtl to generate RTL css from css.
By npm :
npm run build To compile all scss to css and copy all files from resource to public directory.
npm run build-rtl to generate RTL css from css.
Please run the following commands to clear all cache from the project. 
php artisan optimize:clear
php artisan migrate This will migrate the database tables. For more details visit https://laravel.com/docs/10.x/migrations
php artisan serve The development server is accessible at http://localhost:8000.
To run on other port just run command : php artisan serve --port=8001
© Skote.