ychsiao0809/www-repo-template

Laravel Base (5.8)

A website base on Laravel and Bootstrap for HackerSir.

Required

• PHP 7.1.3+
• Yarn

Framework

• Laravel 5.8
• Bootstrap 4
• Font Awesome 5
• Vue.js 2

Lint

• js
  • eslint(airbnb)
• php
  • PSR@2

Including

• Packages
  • predis/predis: ^1.1
  • barryvdh/laravel-debugbar: ^3.2
  • squizlabs/php_codesniffer: *
  • cscc/sso: ^0.4.0

Installation Guide

1. Run the following commands.

# Setting composer config let it can install private repo
composer config http-basic.gitlab.cs.nctu.edu.tw $GITLAB_DEPLOY_USERNAME $GITLAB_DEPLOY_PASSWORD
composer install
yarn

2. Copy .env.example to .env.

cp .env.example .env

3. Configure environment variables in .env.

4. Generate app key.

php artisan key:generate

5. NCTU CSSSO setting(optional) https://gitlab.cs.nctu.edu.tw/www/cscc-sso/sso-sdk

Workspace

Laradock

In this project we use 26184055c5126dc51f2aadadd7a3b4a9506a1d04

1. Install docker & docker-compose

2. Clone laradock(alreay in git submodule)

git submodule update --init
cd laradock/

3. Copy env-example to .env.

cp env-example .env

4. Create your workspace(in laradock directory)

docker-compose up -d nginx redis mariadb maildev workspace php-fpm

5. Install module in container

cp .env.example.laradock .env
# you must add '--user=laradock' or you will get some promission problem
docker-compose exec --user=laradock workspace bash
# Then see 'Installation Guide' part

DevOps

CI Lint

You can check your .gitlab-ci.yml in CI Lint

Notice

• If you modify some files which need to be compiled, make sure you have run the following command before commit. (For testing in local, you can also compile files by using yarn run dev instead.)

yarn run production