Laravel Installation

Steps to install the Frest Laravel on your system🧑‍💻

System Requirements

Node: v18.0.0 or above (LTS)
PHP: v8.1 or Above
Composer: v2.2 or Above
Laravel: v10.17 or Above

Important! : Before installing the node_modules make sure you have files starting with a dot(.eslintrc, .env etc..). It mostly happens when hidden files are not enabled on your machine and you try to copy our template at some other place on your system.

Important! : If you decide to use npm, make sure you use following command: npm install --legacy-peer-deps

Installation

To migrate latest version of laravel, follow steps of Migrate Laravel Steps and then go ahead with installation.

Installing and running Frest is super easy, please follow below steps and you will be ready to rock 🤘

Open the terminal in your root directory of Frest Laravel.
Use following command to install composer

composer install

Optional: (if not having .env file) Find .env.example file at root folder and rename it to .env by running below command Or also can manually rename it:

For Windows:

ren .env.example .env

For Mac OS and Ubuntu:

mv .env.example .env

Run the following command to generate the key

php artisan key:generate

By running the following command, you will be able to get all the dependencies in your node_modules folder:

yarn

To run the project, you need to run following command in the project directory. It will compile JavaScript and Styles.

yarn dev

To serve the application, you need to run the following command in the project directory

php artisan serve

Now navigate to the given address, you will see your application is running.🥳

To change the port address, run the following command:

php artisan serve --port=8080 // For port 8080

Watching for changes: If you want to watch all the changes, you make in JavaScript and Styles files then run the following command in the root directory:

yarn watch

Building for Production: If you want to run the project and make the build in the production mode then run the following command in the root directory, by default the project will continue to run in the development mode:

yarn prod

Required Permissions

If you are facing any issues regarding the permissions, then you need to run the following command in your project directory:

sudo chmod -R o+rw bootstrap/cache
sudo chmod -R o+rw storage

JetStream Authentication

Please follow our JetStream installation steps to use Authentication in our template.

To integrate with database migrations:

You must have a database or create a new database to proceed further. Find more about database connection here
You have to set your database credentials in .env file.

DB_CONNECTION = mysql
DB_HOST = 127.0.0.1
DB_PORT = 3306
DB_DATABASE = DATABASE_NAME
DB_USERNAME = DATABASE_USERNAME
DB_PASSWORD = DATABASE_PASSWORD

Run the following command to generate migration tables.

php artisan migrate

Run the following command to generate fresh migration tables.(This will remove your current tables from Database and create new one.)

php artisan migrate:fresh

Run following database seeding command to create fake users in database for CRUD app.

php artisan db:seed

You are ready to use CRUD app 👍🏻