ADMCode Starter Template

Create PHP projects based on ADMCode's template.

Installation

Pre-requisites

You need the following installed in your environment before we begin:

PHP >= 5.5.9
The following extensions enabled in php.ini:
- OpenSSL PHP Extension
- PDO PHP Extension
- Mbstring PHP Extension
Composer

Clone this repository

$ git clone https://github.com/admcode/admcode-starter.git
$ cd admcode-starter

Configure your environment file

Run the create-app-env.sh script and follow the instructions to create a .env file to your project.

$ sh create-app-env.sh

If somehow you managed to screw up the .env file, just run the script again to make a new one.

PHP dependencies

Install PHP dependencies through composer by running:

$ composer install

Usage

Important

Your project must be served from the public folder in the server root.

// These will work
www.fakedomain.com/public/
localhost/public/

// These won't
www.fakedomain.com/admcode-starter/public/
localhost/admcode-starter/public/

Change your project encryption key

To change your project encryption key, run the create-app-key.sh and replace your previous project encryption key in the .env file with the key generated.

$ sh create-app-key.sh

Contributing

Fork it
Create your feature branch

$ git checkout -b my-new-feature

Commit your changes

$ git commit -am 'Add some feature'

Push to the branch

$ git push origin my-new-feature

Create a new Pull Request

admcode/admcode-starter