Skip to content

Latest commit

 

History

History
134 lines (87 loc) · 5.41 KB

README.md

File metadata and controls

134 lines (87 loc) · 5.41 KB

PHP Mentoring App

Build Status Codeship Status for phpmentoring/testapp Code Climate

Requirements

You should have Composer installed and available. If you need to install composer, go to their Getting Started docs. If you will be using Vagrant for local development, you'll need to have it installed as well.

Setup

Using Vagrant

  1. Clone this repo.

  2. Go into the folder, and run vagrant up to start the VM.

  3. Add the following entry to your hosts file:

    192.168.56.101 www.mentoring.dev mentoring.dev

  4. Run vagrant ssh to go into the VM.

  5. Change directory to /var/www and run composer install

    If you get an error like the following:

     Could not fetch https://api.github.com/repos/vlucas/phpdotenv/zipball/732d2adb7d916c9593b9d58c3b0d9ebefead07aa, please create a GitHub OAuth token to go over the API rate limit
 Head to https://github.com/settings/tokens/new?scopes=repo&description=Composer+on+packer-virtualbox-iso-1422588891+2015-05-22+0002 to retrieve a token.
 It will be stored in "/home/vagrant/.composer/auth.json" for future use by Composer.

    You will need to navigate to the URL in a browser, authenticate with GitHub, and generate the access token.

  6. Configure Phinx

  7. Run vendor/bin/phinx migrate to run the database migrations.

  8. Copy app/config/parameters.yml.dist to app/config/parameters.yml and configure for your setup

  9. Configure Github

  10. Visit http://mentoring.dev in your browser!

Running Without Vagrant

If you want to help out and cannot download or run Vagrant, you can run the application locally using PHP's built in dev server. You will need the following PHP extensions:

  • php-curl
  • php-intl

Steps:

  1. Clone this repo.

  2. Add the following entry to your hosts file. On unix-like systems, its usually found at /etc/hosts:

    127.0.0.1 www.mentoring.dev mentoring.dev

  3. Change directory to the directory where you cloned the project in step 1 and run composer install

  4. Copy app/config/parameters.yml.dist to app/config/parameters.yml and configure for your setup

  5. Configure Phinx

  6. Run vendor/bin/phinx migrate to run the database migrations.

  7. Configure Github

  8. To run using PHP's built-in server, navigate to the root of the project and run:

    php -S mentoring.dev:8080 -t public public/index.php

  9. Visit http://mentoring.dev:8080 in your browser!

Phinx Configuration

We use Phinx for managing our database migrations. It provides a programmatic way for handling table and data changes. It does require some initial setup however.

  1. From the root project directory, run vendor/bin/phinx init to generate a phinx.yml file.

  2. Edit ./phinx.yml's development section (lines 19-21) with the following values for MySQL.

    name: mentoring
user: mentoring
pass: vagrant

    To use sqlite, in ./phinx.yml change change the adapter to sqlite (line 17) the name (line 19) to data/mentoring.db.

  3. Edit ./phinx.yml's paths.migrations value (line 2) to:

    %%PHINX_CONFIG_DIR%%/data/migrations

App Configuration

All configuration is store in app/config/parameters.yml. The app ships with a .dist version that you will need to copy/paste into the above path. You can then edit it to your needs.

Github

The application uses Github for authentication. If you are developing or working on features that require a user login, you will need to set up a new Github Application to generate a secret and a key.

Instructions for doing this are available at https://github.com/settings/applications/new.

Set the Homepage and Authorization callback URL to http://mentoring.dev:8080 or http://mentoring.dev, depending on how you set up your hosts file.

Once you have that completed, you will need to add them to the parameters.yml file, like this:

github:
  api_key: 'keyfromgithub'
  api_secret: 'secretfromgithub'

Email in Development

Before you start the VM, you need to change your parameters.yml file. To use mailcatcher, you'll want the following config:

mail:
  host: '0.0.0.0'
  port: 1025

Mailcatcher is installed in the VM, but to use it you need to ssh into the VM and execute the following command to start the mail server:

mailcatcher --ip=0.0.0.0

You can then view all emails being sent out by the app in your host machine's browser at the following address:

http://192.168.56.101:1080

Database Configuration

This app uses the Doctrine DBAL as it's underlying database layer, so you can configure the database using the options in the Silex documentation.

Explicitly, we support MySQL and it's dialect of SQL. Others may work, like SQLite for development environments, but most of the code is written with MySQL in mind.

You can configure the database settings under the database: key.