CommunityCrit

This app is build using PHP and Laravel 5.4.

Quickstart

cp .env.example .env
composer install
npm install && npm run production
php artisan key:generate
php artisan migrate

Requirements

• PHP
• Composer
• NodeJS + npm
• MySQL

Installing NodeJS & NPM

If you don't already have node and npm installed, visit the node website to download and install the proper package. npm comes standard with node as a package so no need to install it separately.

Using nvm is recommended to help manage node versions.

Installing npm packages

Use this command to install the required packages:

npm install

Installing PHP dependencies

Use this command to install the required PHP packages:

composer install

Development Environment

Using Laravel Valet is recommended to make your life easier.

Installation

macOS with Homebrew: Quick Start

Run from project directory

brew update
brew tap homebrew/php
brew install php71 nvm mysql
composer install
cp .env.example .env # Fill out .env
php artisan key:generate
php artisan migrate
nvm use
npm install
npm run dev
composer global require laravel/valet
valet install
valet link
# Visit communitycrit.dev in your browser

Composer

On macOS, make sure you have Homebrew installed.

brew update
brew tap homebrew/dupes
brew tap homebrew/php
brew install php71
brew install composer

Make sure to place the ~/.composer/vendor/bin directory in your PATH

Development Web Server

Choose one method:

Laravel Valet (Highly Recommended)

If you're using macOS, using Laravel Valet is highly recommended.

Quickstart

Make sure you have Homebrew installed.

brew install
brew update
brew install homebrew/php/php71
composer global require laravel/valet

PHP Development Server

You can use Laravel's built-in server but it's not highly recommended:

php artisan server

This will allow you to access the server at 127.0.0.1:8000.

Other servers

If you're using another web server (nginx, apache, etc.) configure the public folder to be your document root.

MySQL

If you don't have MySQL already.

brew install mysql

Set up your environment variables

cp .env.example .env

Edit the values in .env with your local values.

Install packages

composer install - Install PHP packages

npm install - Install node packages for frontend build

Migrate

php artisan migrate

Build assets

For development

npm run dev

For production

npm run prod