This is the online photobook, initially built for scoutsgroup Scouting Rudyard Kipling, but now also open for other scoutsgroups or organisations. It features:
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment chapter for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
A step by step series of examples that tell you how to get a development env running
create a local .env
cp .env.example .envNow setup the .env file for your environment
Minimal setup is setting up your database connection
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=photobook
DB_USERNAME=photobook
DB_PASSWORD=photobookInstall composer dependencies
composer installGenerate a local key for laravel (stored in .env)
php artisan key:generatelink the storage folder
php artisan storage:linkMigrate the database (from scratch) to the latest version
php artisan migrateSeed the database with the bare essential data (like basic permissions and roles)
php artisan db:seedTo see a list of available artisan commands
php artisan listAs you will use artisan a lot (and we as programmers are lazy) make an alias in your .bash_profile
alias art='php artisan'We also need to install npm with its packages
npm installAnd run npm to let it generate a nice and clean looking website for you
npm run devRun all tests
composer testThe above example runs phpunit, phpcs, phpmd, and larastan. Info found in the rest of this paragraph.
This command will run all php unit tests found in the test folder. this includes Unit as well as Feature tests.
./vendor/bin/phpunitFor running all analysers at once run:
composer lintPHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.
Configuration of CodeSniffer is found in phpcs.xml
./vendor/bin/phpcsWhat PHPMD does is: It takes a given PHP source code base and look for several potential problems within that source. These problems can be things like:
Configuration of MessDetector is found in phpmd.xml
#executable path
# tested folder or file
# output format
# configuration
./vendor/bin/phpmd app text phpmd.xmlDiscover bugs in your code without running it - phpstan wrapper for Laravel.
Configuration of Larastan is found in phpstan.neon
php artisan code:analyse --level=maxIf the application is already installed for the first time, skip the First time deployment paragraph and go straight to Updating.
We will go a little bit faster here, if you would like some more explanation, go to the above paragraph Installing, or visit the laravel documentation page
download the repo on the server (via git or filetransfer) and make sure you are in the folder of this repo.
create a local .env
cp .env.example .envNow setup the .env file for your environment. At least setup the next fields
APP_ENV=production
APP_DEBUG=false
APP_URL=https://your.url
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your-database
DB_USERNAME=your-user
DB_PASSWORD=your-password
now run the next commands to setup the server
composer install
php artisan package:discover
php artisan key:generate
php artisan storage:link
php artisan migrate
php artisan cache:clear
php artisan config:cache
npm ci
npm run production
php artisan up
Install a cronjob to call the laravel kernel which dispatches all jobs internally, yes it has to run every minute. Laravel will determine for itself when to run the jobs.
crontab -e
# add the next line to file
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1Make sure you have the base setup the apache or nginx config correctly and routed to the public folder.
/public folder in the repo (NOT TO THE BASE FOLDER)Laravel includes a public/.htaccess file that is used to provide URLs without the index.php front controller in the path.
Before serving Laravel with Apache, be sure to enable the mod_rewrite module so the .htaccess file will be honored by the server.
If the .htaccess file that ships with Laravel does not work with your Apache installation, try this alternative:
Options +FollowSymLinks -Indexes
RewriteEngine On
RewriteCond %{HTTP:Authorization} .
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [L]If you are using Nginx, the following directive in your site configuration will direct all requests to the index.php front controller:
location / {
try_files $uri $uri/ /index.php?$query_string;
}run command
php artisan downUpload your new repository to the server.
Make sure you do not edit or overwrite:
.env unless edits are specified for that particular updatevendor/storage/node_modules/run commands
composer install
php artisan migrate
php artisan cache:clear
php artisan config:cache
npm ci
npm run production
php artisan upLaravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
Laravel is accessible, powerful, and provides tools required for large, robust applications.
Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
If you don't feel like reading, Laracasts can help. Laracasts contains over 1400 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.