https://github.com/jedymatt/laravel-readme-template

laravel laravel-framework readme-md readme-template

Last synced: 3 months ago
JSON representation

Laravel README file Template

README

# Application Name

![Alt text](https://via.placeholder.com/1024x768?text=Optional+Image+Here)

{ Optional, Insert badges here}

Application description

## Prerequisites

* XAMMP or Docker
* Node.js
* composer

## Run Locally

Clone the repository and go to {application directory} directory
```shell
git clone https://github.com/{username}/{repository name}.git

cd {application directory}
```

Generate .env file
```shell
cp .env.example .env
```

Then, configure the .env file according to your use case.

Install the dependencies and then compile the assets
```shell
composer install

npm install
npm run dev
```

Populate the tables to the database
```shell
php artisan migrate
```

Optional: Seed data to the dabase
```shell
php aritsan db:seed
```

Generate app key
```shell
php artisan key:generate
```

Run the application
```shell
php artisan serve
```

Finally, visit http://localhost:8000 to view the site.