How can I organize my laravel project's github repository so that users can easily install and run it?

Question

Five months ago I created a pretty extensive Laravel Blog Management system. I am now at a point where I am looking for a job and would like for potential employers to be able to easily install and run my project to check it out. I want to include instructions in the readme.md on how to get it started but I've just realized that I can't figure out how to run it myself!

Here is the repository: https://github.com/colesam/Laravel-Blog

Here is what I've tried:

git clone git@github.com:colesam/Laravel-Blog.git
composer install
php artisan serve

This copied the repo into my xampp/htdocs directory and ran it. XAMPP is currently running with MySQL and Apache running.

The console responds by telling me it's being served on localhost:8000. Unfortunately I receive an error message on the actual html doc:

What is going wrong with my project and how can I make this as easy as possible for my potential employers / anyone who would like to download and check out my project?

Answer 1

It's really easy actually. Takes about ~5 minutes. Here are the steps:

1. Clone the project
2. Create a database
3. Copy .env.example to .env and set the correct database credentials
4. Run php artisan key:generate to generate the app key
5. Run php artisan migrate to create the tables
6. Run php artisan serve

And you're done.