Skip to content
This repository has been archived by the owner on May 1, 2019. It is now read-only.

Improvements in README #331

Merged
merged 3 commits into from
Jan 24, 2015
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
[![Build Status](https://travis-ci.org/zendframework/modules.zendframework.com.svg?branch=master)](https://travis-ci.org/zendframework/modules.zendframework.com)

# ZF2 Modules Site
Version 0.0.1
# ZF2 Modules Site [![Build Status](https://travis-ci.org/zendframework/modules.zendframework.com.svg?branch=master)](https://travis-ci.org/zendframework/modules.zendframework.com)

## Introduction

Expand All @@ -11,32 +8,30 @@ This site will eventually be a community site for publishing and sharing Zend Fr

###Main Setup

* Clone this project git clone git://github.com/zendframework/modules.zendframework.com.git.
* Run **composer install** to initialize your vendors
* Import data/0.sql into your database
* Create a new Application in github here. https://github.com/settings/applications/new
* Clone this project `git clone git://github.com/zendframework/modules.zendframework.com.git`
* Run `composer install` to initialize your vendors
* Import `data/0.sql` into your database
* [Create a new application in GitHub](https://github.com/settings/applications/new)
* Main URL and CALLBACK url must be the same without any routing. e.g. http://modules.zendframework.com
* Copy config/autoload/github.local.php.dist to config/autoload/github.local.php and enter the Id and Secret provided during the Application registration on github.
* Copy config/autoload/database.local.php.dist to config/autoload/database.local.php and enter your database credentials here.
* Copy config/autoload/cache.local.php.dist to config/autoload/cache.local.php. It's optional
* Copy `config/autoload/github.local.php.dist` to `config/autoload/github.local.php` and enter the Id and Secret provided during the application registration on GitHub
* Copy `config/autoload/database.local.php.dist` to `config/autoload/database.local.php` and enter your database credentials here
* Copy `config/autoload/cache.local.php.dist` to `config/autoload/cache.local.php`. It's optional

###Vagrant Setup

* Clone this project: `git clone git://github.com/zendframework/modules.zendframework.com.git`
* Create a new Application in github [here](https://github.com/settings/applications/new)
* [Create a new application in GitHub](https://github.com/settings/applications/new)
* Main URL and CALLBACK url must be the same without any routing. e.g. http://modules.zendframework.com
* Remove the `.dist` suffix from the files in `config/autoload` and edit them according to your own credentials
- The database information for vagrant is:
- Username: modules
- Database name: modules
- Password: modules
- Username: `modules`
- Database name: `modules`
- Password: `modules`
* Run `vagrant up` (You will need [Vagrant](http://www.vagrantup.com/))
* Add an entry in your hosts (`/etc/hosts` or `C:\Windows\system32\drivers\etc\hosts`):
- `192.168.56.101 modules.zendframework.dev`
* Browse to http://modules.zendframework.dev/

## Deployment

The master branch of this repository is automatically deployed live to
[modules.zendframework.com](http://modules.zendframework.com/) every 10
minutes.
The master branch of this repository is automatically deployed live to [modules.zendframework.com](http://modules.zendframework.com/) every 10 minutes.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The master branch is currently manually deployed by @GeeH, we don't have an automated deployment process as of the moment. Hoping to have one soon, though!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So remove this one?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either remove the whole section, or maybe better, replace with a note that it's manually deployed. What do you think?