Sha256: c5ca7437a5b7708d5ef77fc9da7f7ffd989292394d8e0e57afaeefaac555ad67

Contents?: true

Size: 1.98 KB

Versions: 3

Compression:

Stored size: 1.98 KB

Contents

[![security](https://hakiri.io/github/PHCNetworks/phc-members/master.svg)](https://hakiri.io/github/PHCNetworks/phc-members/master)
[![Code Climate](https://codeclimate.com/github/PHCNetworks/phc-members/badges/gpa.svg)](https://codeclimate.com/github/PHCNetworks/phc-members)
[![Dependency Status](https://gemnasium.com/badges/github.com/PHCNetworks/phc-members.svg)](https://gemnasium.com/github.com/PHCNetworks/phc-members)
[![Gem Version](https://badge.fury.io/rb/phcmembers.svg)](https://badge.fury.io/rb/phcmembers)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/PHCNetworks/phc-members/blob/master/MIT-LICENSE)  

### PHCMembers(9) (Membership & Directory Engine) Documentation
PHCMembers(9) rails engine to manage membership information and directory listings.  

* Fast setup of membership and web directory modules.
* Directory and listings manager with a web directory API.
* Member's list, contact information, and listings manager.
* Easy app integration with views that can be customized.
* User authentication will activate when Devise is installed.

#### Step 1 - Add PHCMembers to your gemfile and run command   

	gem 'phcmembers', '~> 9.0'
	bundle install

#### Step 2 - Add PHCMembers Database Tables  
To copy PHCMembers' required database migrations, copy each command individually to your terminal's command line.  

	rails phcmembers:install:migrations
	rails db:migrate

#### Step 3 - Mount PHCMembers & Add Routes
Mount PHCMembers by adding code below to your routes file.  

	mount Phcmembers::Engine, :at => '/'

#### Step 4 - Recompile Assets  
To properly function re-compile your application's assets to copy over required files.

	rails assets:clobber
	rails assets:precompile  

#### Step 5 - Generate Views  (Customization)
Generate views for customization and app integration.  

	rails generate phcmembers:views

#### Additional Information

- [Past Security Patch Notes](https://github.com/PHCNetworks/phc-members/wiki/Critical-Security-Updates)

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
phcmembers-12.2.1 README.md
phcmembers-11.0.0 README.md
phcmembers-10.0.0 README.md